npm.io
2.1.1 • Published 7 months ago

@uplift-ltd/use-on-page-scroll

Licence
MIT
Version
2.1.1
Deps
0
Size
6 kB
Vulns
0
Weekly
0
Stars
2
SummaryDependencyVersions

@uplift-ltd/use-on-page-scroll

Installation

npm i --save @uplift-ltd/use-on-page-scroll

API

useOnPageScroll

Hook to handle scroll up/down events. Returns current and previous y position. Cleans up after itself.

import { useOnPageScroll } from "@uplift-ltd/use-on-page-scroll";

useOnPageScroll({
  onScrollUp: ([newYPosition, lastYPosition]) => {
    console.log(newYPosition, lastYPosition);
  },
  onScrollDown: ([newYPosition, lastYPosition]) => {
    console.log(newYPosition, lastYPosition);
  },
});