npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@kylelwm/react-ui-scrollspy

v1.1.1

Published

Simple, Easy To Use and Customisable ScrollSpy component for react with callback, typescript and throttle support among others

Downloads

27

Readme

ScrollSpy Demo

React UI ScrollSpy

npm npm License MIT PRs Welcome

React TypeScript NPM

Make sure you ⭐️ this repository if you find it helpful or interesting :)

✨ Installation

React 18

npm install --save react-ui-scrollspy

OR

yarn add react-ui-scrollspy

React 17 and below

npm install --save [email protected]

OR

yarn add [email protected]

🎞 Demo

Try it your self here!

| Demo 1 | Demo 2 | | :-------------------------------------------- | :--------------------------------------------- | | ScrollSpy Demo | ScrollSpy Demo |

⚙️ Usage

  1. In your navigation component
<div>
  <p data-to-scrollspy-id="first">Section 1</p>
  <p data-to-scrollspy-id="second">Section 2</p>
</div>
  1. Wrap the elements you want to spy on in the <ScrollSpy> component.
import ScrollSpy from "react-ui-scrollspy";

<ScrollSpy>
  <div id="first">
    Lorem ipsum dolor sit amet consectetur adipisicing elit. Aut dolores
    veritatis doloremque fugit. Soluta aperiam atque inventore deleniti,
    voluptatibus non fuga eos magni natus vel, rerum excepturi expedita.
    Tempore, vero!
  </div>
  <div id="second">
    Lorem ipsum dolor sit amet consectetur adipisicing elit. Aut dolores
    veritatis doloremque fugit. Soluta aperiam atque inventore deleniti,
    voluptatibus non fuga eos magni natus vel, rerum excepturi expedita.
    Tempore, vero!
  </div>
</ScrollSpy>
  1. Write styles for when the navigation element which is active in your index.css
.active-scroll-spy {
  background-color: yellowgreen;
  border-radius: 15px;
}

📝 Notes

Incase the ScrollSpy is not working the way you expected, you can try the following:

  • Reduce the value of scrollThrottle.

  • If your page contains a navbar a header consider adding the following CSS

html {
  scroll-padding-top: 120px; /* height of your navbar */
}

💡 Props

🔧 Children

| Attributes | Type | Description | Default | Required | | :--------- | :---------- | :------------------------------------------------- | :------ | :------- | | children | ReactNode | Each direct child Element should contain an id | - | yes |

🔧 Refs

| Attributes | Type | Description | Default | Required | | :------------------------- | :------------------------------------------------ | :------------------------------------------------------------------------------------------------------ | :------ | :------- | | navContainerRef | MutableRefObject<HTMLDivElement | null> | ref to your navigation container containing items with data-to-scrollspy-id attributes | - | no | | parentScrollContainerRef | MutableRefObject<HTMLDivElement | null> | If you want to spy only on a particular scrollable container (Element) then pass its ref to this prop | - | no |

🔧 Throttle

| Attributes | Type | Description | Default | Required | | :--------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------- | :------ | :------- | | scrollThrottle | number | In milliseconds to throttle the onscroll event. Lower the number, better the response time, higher the performance cost | 300 | no |

🔧 Callback

| Attributes | Type | Description | Default | Required | | :----------------- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | :------ | :------- | | onUpdateCallback | (id: string) => void | Executes this function whenever you scroll to a new ScrollSpy child Element, callback returns the id of that Element as well | - | no |

🔧 Offsets

| Attributes | Type | Description | Default | Required | | :------------- | :------- | :-------------------------------------------------------------------------------------------------------------- | :------ | :------- | | offsetTop | number | Spy will be fired when it has been scrolled offsetTop beyond 50% to the top of the containing element | 0 | no | | offsetBottom | number | Spy will be fired when it has been scrolled offsetBottom beyond 50% to the bottom of the containing element | 0 | no |

🔧 Customize Attributes

| Attributes | Type | Description | Default | Required | | :----------------- | :-------- | :-------------------------------------------------------------------------------------------------------- | :-------------------- | :------- | | useDataAttribute | string | To customize the string after data- | "to-scrollspy-id" | no | | activeClass | string | To customize the class added when the Element in view | "active-scroll-spy" | no | | useBoxMethod | boolean | Set to false if you want your spy to be active only if more than 50% of that div is in the viewport | true | no | | updateHistoryStack | boolean | Set to false to disable the URL getting automatically updated when scrolling | true | no

📝 Authors