@yamada-ui/scroll-area/dist/scroll-area.d.mts

Yamada UI scroll area component

import * as _yamada_ui_core from '@yamada-ui/core';
import { HTMLUIProps, ThemeProps } from '@yamada-ui/core';

interface ScrollAreaOptions {
    /**
     * Scrollbar visibility type.
     *
     * @default 'hover'
     */
    type?: "always" | "hover" | "never" | "scroll";
    /**
     * Delay in milliseconds before scrollbars are hidden.
     *
     * @default 1000
     */
    scrollHideDelay?: number;
    /**
     * Props for inner element.
     */
    innerProps?: HTMLUIProps;
    /**
     * Callback function for when the scroll position changes.
     */
    onScrollPositionChange?: ({ x, y }: {
        x: number;
        y: number;
    }) => void;
}
interface ScrollAreaProps extends HTMLUIProps, ThemeProps<"ScrollArea">, ScrollAreaOptions {
}
/**
 * `ScrollArea` is a component that displays a customized scrollbar.
 *
 * @see Docs https://yamada-ui.com/components/data-display/scroll-area
 */
declare const ScrollArea: _yamada_ui_core.Component<"div", ScrollAreaProps>;

export { ScrollArea, type ScrollAreaProps };