README.md

use-simple-scroll-spy

Tiny scroll spy react hook that just needs the element ids

Installation NPM

pnpm i use-simply-scroll-spy

yarn add use-simply-scroll-spy

npm i use-simply-scroll-spy

Usage

const sectionIds = ["section-1", "section-2"];
const MyComponent: React.FC = () => {
  const activeIndex = useSimpleScrollSpy(sectionIds);
  return (
    <>
      <div id="section-1">My content </div>
      <div id="section-2">My content </div>
    </>
  );
};

The code above is a very simple implementation but the provides an idea of what the hook can achieve and allow to track based on the URL hash. If you hit the page with #section-2 as the default section, the activeIndex will be set propertly.