@designbycosmic/cosmic-react-scroll-hook

cosmic-react-scroll-hook

React hook for listening to window scroll position

Installation notes

yarn add https://github.com/designbycosmic/cosmic-react-scroll-hook.git

Currently this requires the repo to be public.

How to use

// from any functional component

import { useScrollPosition } from "cosmic-react-scroll-hook";

const ScrollWatcher = () => {
  const { scrollX, scrollY } = useScrollPosition();

  return (
    <p>The current scroll position is {`x: ${scrollX}, y: ${scrollY}`}</p>
  );
}

export default ScrollWatcher;

TODO

• determine if repo should be configured as NPM package