Use Scroll Position

Open-code aq-ui React hook for Use Scroll Position.

Installation

pnpm dlx aq-ui@alpha add use-scroll-position

Client module

Import the parts you need, then jump to an export for its contract.

"use client"

import { useScrollPosition } from "@/hooks/use-scroll-position"

const result = useScrollPosition()

Type contract for ScrollPosition.

interface ScrollPosition

Name	Type
`x`	`number`
`y`	`number`

Open-code aq-ui React hook for Use Scroll Position.

function useScrollPosition(target?: Target<Element | Window>, initialValue: ScrollPosition = { x: 0, y: 0 }): ScrollPosition

Name	Type	Default
`target?`	`Target<Element \| Window>`	`—`
`initialValue?`	`ScrollPosition`	`{ x: 0, y: 0 }`

const result = useScrollPosition()

hook-target, use-isomorphic-layout-effect