useScrollPosition
Layout/Viewport
A React hook that tracks the current window scroll position in real-time with SSR-safe initialization.
Installation
npm install @thibault.sh/hooks
API Reference
Signature
interface ScrollPosition {
x: number;
y: number;
}
function useScrollPosition(): ScrollPosition
Returns
ScrollPosition
An object containing the current horizontal and vertical scroll positions.
Properties:
Property | Type | Description |
---|---|---|
x | number | Horizontal scroll position in pixels. |
y | number | Vertical scroll position in pixels. |