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 of an element that must have a scroll handle behavior.

An object which identity never changes between renders.

isActive: boolean

true if the scrollbar handle drag has started, or if a container is being scrolled. Scrollbar stays active for deactivateDelay after becoming idle.

isDragged: boolean

true if a scroll handle is currently being dragged.

isScrollable: boolean

true if container is scrollable, and scrollbar has something to scroll.