Interface HeadlessScrollbarValue

A value returned from the useScrollbar hook.

interface HeadlessScrollbarValue {
    handleProps: DOMAttributes<Element>;
    isActive: boolean;
    isDragged: boolean;
    isScrollable: boolean;
}

Properties

handleProps: DOMAttributes<Element>

Props for the element that implements the scroll handle behavior.

The object identity never changes between renders.

isActive: boolean

true if the scrollbar handle drag has started or the container is being scrolled.

The scrollbar remains active for deactivateDelay after becoming idle.

isDragged: boolean

true if the scrollbar handle is currently being dragged.

isScrollable: boolean

true if the container is scrollable and the scrollbar has content to scroll.