Skip to main content
Version: v4.5.0

use-on-window-scroll

About​

A React hook for adding an event listener for window scroll


Installation​

npm install --save @rooks/use-on-window-scroll

Importing the hook​

import useOnWindowScroll from "@rooks/use-on-window-scroll"

Usage​


function Demo() {
useOnWindowScroll(() => console.log("window scrolled"))
return <p> Hello world </p>
}

render(<Demo/>)

Arguments​

ArgumentsTypeDescriptionDefault value
callbackfunctionCallback function which needs to run on unmountundefined
whenbooleanWhen the event handler should be activetrue

A React hook for adding an event listener for window scroll​

Join Bhargav's discord server​

You can click on the floating discord icon at the bottom right of the screen and talk to us in our server.