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

4.11.2 • Public • Published

@rooks/use-window-scroll-position

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 to get the scroll position of the window

Installation

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

Importing the hook

import useWindowScrollPosition from "@rooks/use-window-scroll-position"

Usage

function Demo() {
  const {scrollX, scrollY} = useWindowScrollPosition();  
  return <div>
    <p> Window X position is {scrollX}</p>
    <p> Window Y position is {scrollY}</p>
  </div>
}

render(<Demo/>)

Package Sidebar

Install

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

Weekly Downloads

0

Version

4.11.2

License

MIT

Unpacked Size

15.5 kB

Total Files

14

Last publish

Collaborators

  • imbhargav5