npm.io
0.1.7 • Published 3 years ago

use-position-y-offset

Licence
ISC
Version
0.1.7
Deps
2
Size
3 kB
Vulns
0
Weekly
0

usePositionYOffset

React Hook that triggers on window scroll and return Y offset

npm install use-position-y-offset 

or

yarn add use-position-y-offset 


Example
In your React component:
import usePositionYOffset from "position-y-offset"

function PositionInfo() {
  const postitionYOffset = usePositionYOffset()

  return <div>position = ({ postitionYOffset })</div>
}

Settings:
debounceTime - number (default 200ms)

...
const postitionYOffset = usePositionYOffset({debounceTime:200})

callback - function (default undefined)

...
const handlePositionChange = (positionYOffset) => {
    console.log(positionYOffset);
}

usePositionYOffset({function: handlePositionChange})

Word from author

All the best :3

Keywords