React Hookers - v6.3.0
    Preparing search index...

    Interface HeadlessScrollbarProps

    Props for the useScrollbar hook.

    interface HeadlessScrollbarProps {
        containerRef: RefObject<Element | null>;
        deactivateDelay?: number;
        getTrackRect: () => DOMRect | undefined;
        handleMargin?: number;
        onScroll?: (info: Readonly<ScrollbarInfo>) => void;
        orientation?: "vertical" | "horizontal";
    }
    Index

    Properties

    containerRef deactivateDelay? getTrackRect handleMargin? onScroll? orientation?

    Properties

    containerRef: RefObject<Element | null>

    A reference to a scrollable container element.

    deactivateDelay?: number

    A delay after which the scrollbar is deactivated.

    3000
    getTrackRect: () => DOMRect | undefined

    Returns the bounding rect of the scrollbar track.

    handleMargin?: number

    The minimum distance between the bounds of the scrollbar track and the scrollbar handle along the scrollbar orientation.

    0
    onScroll?: (info: Readonly<ScrollbarInfo>) => void

    A callback invoked when the container is scrolled.

    Type Declaration

    orientation?: "vertical" | "horizontal"

    The orientation of the scrollbar track along which the scrollbar handle can be dragged.

    "vertical"

    Settings

    Member Visibility

    On This Page

    Properties