Astryx Design System

useScrollOverflow@astryxdesign/core v0.0.15 · useScrollOverflow

Usage

Tracks scroll overflow state for a horizontally scrollable container. Returns a ref callback and state booleans that update as the user scrolls or the container resizes. Uses scroll event listeners and ResizeObserver for reactive updates. Tolerance of 1px is applied to avoid sub-pixel false positives.

ts
import {useScrollOverflow} from '@astryxdesign/core/hooks'

Best practices

Guidance	Practices
Do	Use to show/hide scroll navigation buttons or fade edges on carousels and horizontal lists.
Do	Apply the scrollRef to a container with overflow-x: auto or overflow-x: scroll.
Don't	Use for vertical scroll tracking; this hook only measures horizontal overflow.

Returns

Field	Type	Description
scrollRef	React.RefCallback<HTMLElement>	Ref callback to attach to the horizontally scrollable container element.
overflowStart	boolean	Whether content overflows the start edge (left in LTR, right in RTL).
overflowEnd	boolean	Whether content overflows the end edge (right in LTR, left in RTL).
hasOverflow	boolean	Whether the container has any scroll overflow at all (scrollWidth > clientWidth).