Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@react-hook/window-scroll

Package Overview
Dependencies
Maintainers
1
Versions
24
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@react-hook/window-scroll

A React hook for updating components when the scroll position of the window on the y-axis changes

  • 1.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
39K
decreased by-20.96%
Maintainers
1
Weekly downloads
 
Created
Source

useWindowScroll()

Bundlephobia Types NPM Version MIT License

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 /*fps*/)
  return <div>scroll pos: {scrollY}</div>
}

API

useWindowScroll(fps?: number): number

Arguments
TypeDefaultDescription
fpsnumber30Defines the rate in frames per second with which the scroll position is updated
Returns scrollY: number
TypeDescription
scrollYnumberThe current scroll position of the window on the y-axis

LICENSE

MIT

Keywords

FAQs

Package last updated on 23 Apr 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc