@yamada-ui/react/dist/types/components/scroll-area/use-scroll-area.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { HTMLProps, PropGetter } from "../../core/components/index.types.js";
import "../../core/index.js";

//#region src/components/scroll-area/use-scroll-area.d.ts
interface UseScrollAreaProps extends HTMLProps {
  /**
   * Scrollbar visibility type.
   *
   * @default 'hover'
   */
  type?: "always" | "hover" | "never" | "scroll";
  /**
   * Delay in milliseconds before scrollbars are hidden.
   *
   * @default 1000
   */
  scrollHideDelay?: number;
  /**
   * Callback function for when the scroll position changes.
   */
  onScrollPositionChange?: ({
    x,
    y
  }: {
    x: number;
    y: number;
  }) => void;
}
declare const useScrollArea: ({
  id,
  ref,
  type,
  scrollHideDelay,
  onScrollPositionChange,
  ...rest
}?: UseScrollAreaProps) => {
  isAlways: boolean;
  isHidden: boolean;
  isHovered: boolean;
  isNever: boolean;
  isScrolling: boolean;
  getRootProps: PropGetter<"div", undefined, undefined>;
};
type UseScrollAreaReturn = ReturnType<typeof useScrollArea>;
//#endregion
export { UseScrollAreaProps, UseScrollAreaReturn, useScrollArea };
//# sourceMappingURL=use-scroll-area.d.ts.map