ScrollSpy React Component - Automatically update navigation components based on scroll position to indicate which link is currently active in the viewport.
npm install react-scrollspy-navigation
React Component, that automatically update navigation components based on scroll position to indicate which link is
currently active in the viewport. It also scrolls (navigation) to viewport when click on a navigation component.
- How to install
- How to use it
- Step 1: Content
- Step 2: Navigation
- Configuration
- Optional ScrollSpy props
- onClickEach(event, internalClickHandler, container)
- onChangeActiveId(currentId, prevId)
- Compatibility
- Example code
- Guidelines
- License
Install via NPM or Yarn package manager
``
npm i react-scrollspy-navigation
`
yarn add react-scrollspy-navigation
Add a unique id to content blocks or heading tags for the elements you want to spy on. There is nothing more to do
with the content elements. It's awfully simple so far, right?
`jsx
// Content blocks
const ContentWithBoxes = () => {
return (
<>
);
};
// Heading tags
const ContentWithHeaders = () => {
return (
<>
Target 1
Target 2
Target 3
);
};
`
Wrap your navigation structure with ScrollSpy component. Use only a tags whose href attribute is the hash link ofid
the of an existing content element. You can use structures of any complexity or depth in the ScrollSpy component,ScrollSpy
and you can nest multiple components (although this works, it is not recommended). Don't worry, ScrollSpy
won't add any additional structures to the child component.
_Note: If you are new to URL hashes, here is some information: https://en.wikipedia.org/wiki/URI_fragment_
`jsx`
import ScrollSpy from 'react-scrollspy-navigation';
`jsx`
const Navigation = () => {
return (
);
};
Don't forget to specify in the activeClass prop what className to add to the currently active link. Congratulations,ScrollSpy
we are done, it was that simple. Continue reading the documentation to find out what options are available to configure
how works.
_Note: The much loved Refs used in the previous version and React were thrown away._
| Prop | Type | Default | Description |
| ---------------- | ------------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| activeClass | string | '' | Class name(s) to be applied to the active link |
| activeAttr | boolean | false | If true, the active link will have an attribute data-active attached to it. |
| offsetTop | number | 0 | Offset the final scroll position from top in pixels. |
| offsetLeft | number | 0 | Offset the final scroll position from left in pixels. |
| behavior | 'smooth' \| 'instant' \| 'auto' | 'smooth' | Behavior of the scroll animation. See: Element: scrollTo() |
| root | HTMLElement \| null | null | Root element for the intersection observer. See: IntersectionObserver: IntersectionObserver() |
| rootMargin | string | '0px' | Root margin for the intersection observer. See: IntersectionObserver: IntersectionObserver() |
| threshold | number \| number[] | [0, 0.25, 0.5, 0.75, 1] | Thresholds for the intersection observer. See: IntersectionObserver: IntersectionObserver() |
| onClickEach | function | undefined | Callback function for handle the click event |
| onChangeActiveId | function | undefined | Callback function for handle the active element change event |
- event: The original click eventinternalClickHandler
- : The internal function that scrolls to the element. This should be called at the end of theonClickEach
function, as you want the internal click handler to run.container
- : Container element that is being scrolled. Always try to find the scrollable parent of the linked element.
Example:
`jsx
const Comp = () => {
const onClickEach = (e, next, container) => {
console.log('The clicked element:', e.target);
console.log('The target container element:', container);
next();
};
return
};
`
- currentId: The id of the active elementprevId
- : The id of previous active element
Example:
`jsx
const Comp = () => {
const onChangeActiveId = (current, prev) => {
console.log('Active element changed');
console.log({ current, prev });
};
return
};
`
The component depends on the following functions or classes, which define its compatibility.
- Scroll methods on elements (scroll, scrollTo, scrollBy):
supported browsers
- IntersectionObserver API: supported browsers
- Supported Environments: ESModules, CommonJS, TypeScript`
Check out the interactive demo and example codes.
To learn about the guidelines, please read the Code of Conduct,
Contributing and Security Policy documents.
MIT License @ 2021 Zsolt Tövis
If you found this project interesting, please consider supporting my open source work by
sponsoring me on GitHub /
sponsoring me on PayPal /
give the repo a star.