@react-hooks-custom/use-scroll NPM

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

Quick Start

import useScroll from '@react-hooks-custom/use-scroll'

const Component = (props) => {
  const { scrollX, scrollY } = useScroll();

  return <div>scroll pos: {scrollX}, {scrollY}</div>
}

API

useScroll () => ScrollType

type ScrollType = {
  scrollX: number;
  scrollY: number;
}

Returns { scrollX, scrollY }

	Type	Description
scrollX	number	The current scroll position of the window on the x-axis
scrollY	number	The current scroll position of the window on the y-axis

LICENSE

MIT

react react hook hook react hooks hooks window scroll window scroll hook scroll position viewport viewport scroll viewport scroll hook usewindowscroll use window scroll react window scroll hook react scroll position hook usescrollposition use scroll position scroll position hook

@infinitebrahmanuniverse/nolb-_react-h @everything-registry/sub-chunk-764

1.1.1

4 years ago

1.1.0

4 years ago

1.0.0

4 years ago