@react-hook/window-scroll

useScrollPosition()

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 useScrollPosition from '@react-hook/window-scroll'

const Component = props => {
  const scrollY = useScrollPosition(60 /*fps*/)
  return <div>scroll pos: {scrollY}</div>
}

API

useScrollPosition(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