import React, { ComponentType, ReactNode, Ref, RefObject } from 'react';
import type { CustomEasing } from 'smooth-scroll-into-view-if-needed';
import type { CustomScrollBehaviorCallback } from 'scroll-into-view-if-needed/typings/types';
import { ConfigContextProps, OcThemeName } from '../ConfigProvider';
import { observerOptions as defaultObserverOptions } from './Settings';
import { autoScrollApiType } from './autoScrollApi';
import { OcBaseProps } from '../OcBase';
import { PaginationLocale } from '../Pagination';
import { ButtonProps } from '../Button';
export declare const DEFAULT_GAP_WIDTH: number;
export declare const DEFAULT_TRANSITION_DURATION: number;
export declare const OCCLUSION_AVOIDANCE_BUFFER_LARGE: number;
export declare const OCCLUSION_AVOIDANCE_BUFFER_MEDIUM: number;
export declare const OCCLUSION_AVOIDANCE_BUFFER_SMALL: number;
export declare type CarouselTransition = 'push' | 'crossfade';
export declare type CarouselType = 'slide' | 'scroll';
export declare type CustomScrollBehavior<T> = ScrollBehavior | CustomScrollBehaviorCallback<T>;
export declare type Item = [string, IntersectionObserverItem];
export declare type ItemOrElement = IntersectionObserverItem | Element | undefined;
export declare type ItemType = React.ReactElement<{
    /**
     * The item id.
     */
    itemId: string;
}>;
export declare type visibleElements = string[];
export declare enum CarouselSize {
    Large = "large",
    Medium = "medium",
    Small = "small"
}
export interface DataType {
    /**
     * The interval timeout.
     */
    timeout?: null | ReturnType<typeof setTimeout>;
}
export interface ContextProps {
    /**
     * Sets the animation state.
     */
    setAnimating: (a: boolean) => void;
    /**
     * The custom interval.
     */
    setCustomInterval: (a: boolean | number) => void;
}
export declare const CarouselContext: React.Context<ContextProps>;
export declare const VisibilityContext: React.Context<autoScrollApiType>;
export declare const dataKeyAttribute: string;
export declare const dataIndexAttribute: string;
export declare const id: string;
export declare const itemClassName: string;
export declare const separatorClassName: string;
export declare const separatorString: string;
export interface CarouselProps extends Omit<OcBaseProps<HTMLDivElement>, 'onMouseDown' | 'onMouseMove' | 'onMouseUp' | 'onWheel'> {
    /**
     * index of the active item.
     * @default 0
     */
    activeIndex?: number;
    /**
     * Whether to automatically animate slide transitions.
     * @default true
     */
    auto?: boolean;
    /**
     * Carousel scroll menu props.
     * Use when Carousel type is 'scroll'.
     */
    carouselScrollMenuProps?: ScrollMenuProps;
    /**
     * Configure how contextual props are consumed
     */
    configContextProps?: ConfigContextProps;
    /**
     * Whether to display the previous and next controls.
     * @default true
     */
    controls?: boolean;
    /**
     * The Carousel gradient state.
     * @default false
     */
    gradient?: boolean;
    /**
     * The amount of time to delay between automatically cycling an item.
     * If false, carousel will not automatically cycle.
     * Only available for Carousel type 'slide'.
     */
    interval?: boolean | number;
    /**
     * The Carousel locale.
     * @default 'enUS'
     */
    locale?: PaginationLocale;
    /**
     * Set whether the carousel should cycle continuously or have hard stops.
     * @default true
     */
    loop?: boolean;
    /**
     * The next icon button aria-label string.
     * @default 'Next'
     */
    nextIconButtonAriaLabel?: string;
    /**
     * The next icon button props.
     */
    nextButtonProps?: ButtonProps;
    /**
     * Callback fired on mouse enter event.
     */
    onMouseEnter?: () => React.MouseEventHandler;
    /**
     * Callback fired when a Carousel transition ends.
     */
    onPivotEnd?: (active: number, direction: string) => void;
    /**
     * Callback fired when a Carousel transition starts.
     */
    onPivotStart?: (active: number, direction: string) => void;
    /**
     * Overlay the controls over the Carousel.
     * @default true
     */
    overlayControls?: boolean;
    /**
     * Adds Pagination at the bottom of the Carousel.
     * @default true
     */
    pagination?: boolean;
    /**
     * If set to 'hover', pauses the cycling of the carousel on
     * mouseenter and resumes the cycling of the carousel on mouseleave.
     * If set to false, hovering over the carousel won't pause it.
     * @default 'hover'
     */
    pause?: boolean | 'hover';
    /**
     * The previous icon button aria-label string.
     * @default 'Previous'
     */
    previousIconButtonAriaLabel?: string;
    /**
     * The previous icon button props.
     */
    previousButtonProps?: ButtonProps;
    /**
     * Whether to scroll by 1 item.
     * Use when type is 'scroll'
     * @default false
     */
    single?: boolean;
    /**
     * The size of the Carousel.
     * @default CarouselSize.Large
     */
    size?: CarouselSize;
    /**
     * Theme of the Carousel.
     * Use with configContextProps.noThemeContext to override theme.
     * @default blue
     */
    theme?: OcThemeName;
    /**
     * Theme container of the Carousel.
     * Use with `theme` to generate a unique container or a common one.
     */
    themeContainerId?: string;
    /**
     * Set type of slide transition.
     * @default 'push'
     */
    transition?: CarouselTransition;
    /**
     * Set the type of Carousel.
     * @default 'slide'
     */
    type?: CarouselType;
}
export interface CarouselSlideProps extends OcBaseProps<HTMLDivElement> {
    /**
     * The active Carousel item.
     */
    active?: boolean;
    /**
     * The slide renderer.
     */
    children?: React.ReactNode;
    /**
     * The direction of the pivot.
     * options: `next` or `previous`.
     */
    direction?: string;
    /**
     * The amount of time to delay between automatically cycling an item.
     * If false, carousel will not automatically cycle.
     */
    interval?: boolean | number;
}
export interface Refs {
    /**
     * The menu item ref.
     */
    [key: string]: React.MutableRefObject<RefObject<HTMLElement>[] | null>;
}
export interface IntersectionObserverItem {
    /**
     * Describes the intersection between the target element and
     * its root container at a specific moment of transition.
     */
    entry: IntersectionObserverEntry;
    /**
     * The item index.
     */
    index: string;
    /**
     * The item key.
     */
    key: string;
    /**
     * The item visibility.
     */
    visible: boolean;
}
export interface scrollToItemOptions {
    /**
     * The boundary element.
     */
    boundary?: HTMLElement | null;
    /**
     * The transition duration.
     */
    duration?: number;
    /**
     * The transition easing curve.
     */
    ease?: CustomEasing;
}
export interface ScrollMenuProps extends Omit<OcBaseProps<HTMLDivElement>, 'onMouseDown' | 'onMouseMove' | 'onMouseUp' | 'onScroll' | 'onWheel'> {
    /**
     * Ref object for access VisibilityContextApi outside of context
     * e.g. apiRef.current.scrollToItem(...)
     */
    apiRef?: React.MutableRefObject<autoScrollApiType>;
    /**
     * The child renderer.
     * Every child should have a unique `itemId` prop.
     */
    children: ItemType | ItemType[];
    /**
     * The container padding around menu items.
     * @default 0
     */
    containerPadding?: number;
    /**
     * Whether to display the previous and next controls.
     * @default true
     */
    controls?: boolean;
    /**
     * The pixel gap between items.
     */
    gap?: number;
    /**
     * Custom classname of item.
     */
    itemClassNames?: string;
    /**
     * Next button component.
     */
    nextButton?: ComponentType;
    /**
     * Disable scrollIntoView polyfill
     */
    noPolyfill?: boolean;
    /**
     * Callback fired on init.
     */
    onInit?: (api: autoScrollApiType) => void;
    /**
     * Callback fired on mouse down.
     */
    onMouseDown?: (arg0: autoScrollApiType) => React.MouseEventHandler;
    /**
     * Callback fired on mouse up.
     */
    onMouseUp?: (arg0: autoScrollApiType) => React.MouseEventHandler;
    /**
     * Callback fired on mouse move.
     */
    onMouseMove?: (arg0: autoScrollApiType) => React.MouseEventHandler;
    /**
     * Callback fired on scroll.
     */
    onScroll?: (api: autoScrollApiType, ev: React.UIEvent) => React.UIEventHandler;
    /**
     * Callback fired when visibility of items change.
     */
    onUpdate?: (api: autoScrollApiType) => void;
    /**
     * Handler on mouse wheel.
     */
    onWheel?: (api: autoScrollApiType, ev: React.WheelEvent) => void;
    /**
     * Options for intersection observer.
     */
    options?: Partial<typeof defaultObserverOptions>;
    /**
     * Overlay the controls over the Carousel.
     * @default true
     */
    overlayControls?: boolean;
    /**
     * Previous button component.
     */
    previousButton?: ComponentType;
    /**
     * The scroll menu ref.
     */
    ref?: Ref<HTMLDivElement>;
    /**
     * Whether the canvas direction is rtl.
     */
    rtl?: boolean;
    /**
     * Custom classname of scroll container.
     */
    scrollContainerClassNames?: string;
    /**
     * Custom classname of wrapper.
     */
    scrollWrapperClassNames?: string;
    /**
     * Custom classname of item separator.
     */
    separatorClassNames?: string;
    /**
     * Transition behavior can be 'smooth', 'auto' or custom function
     * Example:
     * (instructions) => {
     *   const [{ el, left }] = instructions;
     *   const styler = Styler(el);
     *
     *   animate({
     *     from: el.scrollLeft,
     *     to: left,
     *     type: 'spring',
     *     onUpdate: (left) => styler.set('scrollLeft', left),
     *   });
     * }
     */
    transitionBehavior?: string | Function;
    /**
     * Duration of transition.
     * @default 400
     */
    transitionDuration?: number;
    /**
     * Easing function for transition.
     * Example: t => t*(2-t)
     * See https://gist.github.com/gre/1650294#file-easing-js
     */
    transitionEase?: (t: number) => number;
    /**
     * Props for the carousel outer container.
     */
    carouselOuterContainerProps?: React.HTMLAttributes<HTMLDivElement>;
}
export interface ScrollContainerProps extends Omit<OcBaseProps<HTMLUListElement>, 'onScroll'> {
    /**
     * Custom classnames of the scroll container.
     */
    classNames?: string;
    /**
     * The child renderer.
     */
    children?: ReactNode;
    /**
     * The container padding around menu items.
     * @default 0
     */
    containerPadding?: number;
    /**
     * Callback fired on scroll.
     */
    onScroll?: (event: UIEvent) => void;
    /**
     * The scroll container ref.
     */
    ref: Ref<HTMLUListElement>;
    /**
     * Whether the canvas direction is rtl.
     */
    rtl?: boolean;
}
export interface MenuItemsProps {
    /**
     * The child renderer.
     */
    children?: ItemType | ItemType[];
    /**
     * The pixel gap between items.
     */
    gap?: number;
    /**
     * Custom item classnames.
     */
    itemClassNames?: string;
    /**
     * The item refs.
     */
    refs: Refs;
    /**
     * Whether the canvas direction is rtl.
     */
    rtl?: boolean;
    /**
     * Custom separator classnames.
     */
    separatorClassNames?: string;
}
export interface ItemProps {
    /**
     * The child renderer.
     */
    children?: React.ReactNode;
    /**
     * The custom classnames.
     */
    classNames?: string;
    /**
     * The item id.
     */
    id: string;
    /**
     * The item index.
     */
    index: number;
    /**
     * The item refs.
     */
    refs: Refs;
    /**
     * The custom style.
     */
    style?: React.CSSProperties;
}
export interface SeparatorProps {
    /**
     * The separator custom classnames.
     */
    classNames: string;
    /**
     * The separator id.
     */
    id: string;
    /**
     * The separator index.
     */
    index: number;
    /**
     * The separator refs.
     */
    refs: Refs;
    /**
     * The custom style.
     */
    style?: React.CSSProperties;
}