useScroll

Get the scroll position of an element.

Examples

typescript

const position = useScroll(target, shouldUpdate);

Property	Description	Type	Default
target	DOM element or ref object	`Element` \| `Document` \| `(() => Element)` \| `MutableRefObject<Element>`	`document`
shouldUpdate	Whether update position	`({ top: number, left: number }) => boolean`	`() => true`

Property	Description	Type
position	The current scroll position of the element.	`{ left: number, top: number } \| undefined`