@rooks/use-on-window-scroll
TypeScript icon, indicating that this package has built-in type declarations

4.11.2 • Public • Published

@rooks/use-on-window-scroll

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

TitleCard

Build Status

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

Arguments Type Description Default value
callback function Callback function which needs to run on unmount undefined
when boolean When the event handler should be active true

A React hook for adding an event listener for window scroll

Package Sidebar

Install

npm i @rooks/use-on-window-scroll

Weekly Downloads

43

Version

4.11.2

License

MIT

Unpacked Size

12.4 kB

Total Files

13

Last publish

Collaborators

  • imbhargav5