useWindowScroll()
npm i @react-hook/window-scroll
A React hook for updating components when the scroll position of the window on the y-axis changes
Quick Start
import useWindowScroll from '@react-hook/window-scroll'
const Component = props => {
const scrollY = useWindowScroll(60 )
return <div>scroll pos: {scrollY}</div>
}
API
useWindowScroll(fps?: number): number
Arguments
| Type | Default | Description |
---|
fps | number | 30 | Defines the rate in frames per second with which the scroll position is updated |
Returns scrollY: number
| Type | Description |
---|
scrollY | number | The current scroll position of the window on the y-axis |
LICENSE
MIT