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

react-scroll-percentage-hook

v1.2.2

Published

A React hook to monitor component scroll percentage.

Downloads

402

Readme

react-scroll-percentage-hook

Version Badge NPM license GZipped size PRs Welcome Downloads NPM total downloads

A React hook that reports the element's current scroll percentage. Can be used for both scroll axes. Check out the demo for some examples.

Features

  • 🚀 Fast - Built with hooks and functional components only.
  • 📏 No need to specify sizes - No need to pass the dimensions of the component, scrollbar or element
  • 👫 Cross-browser - Works out-of-the-box for most browsers, regardless of version.
  • 📲 Mobile-friendly - Supports mobile devices and touch screens.
  • 🛠 Written in TypeScript - It'll fit right into your existing TypeScript project
  • 💥 Lightweight - Around ~400B

Install

  # with npm
  npm install --save react-scroll-percentage-hook
  # with yarn
  yarn add react-scroll-percentage-hook

Usage

import useScrollPercentage from 'react-scroll-percentage-hook';

const Component = () => {
  // TypeScript example:
  // const { ref, percentage } = useScrollPercentage<HTMLDivElement>(...props);
  const { ref, percentage } = useScrollPercentage();

  return (
    <>
      <p>{`vertical: ${percentage.vertical} horizontal: ${percentage.horizontal}`}</p>
      <div ref={ref}>
        {items.map((item, index) => (
          <div key={index}>{item}</div>
        ))}
      </div>
    </>
  );
};

API

| Name | Description | Type | Required | Default Value | | ------------------ | -------------------------------------------------------------------- | ------------- | :------: | ------------- | | windowScroll | If enabled uses window scroll | boolean | ❌ | false | | onProgress | Callback called when scrolling ({ vertical, horizontal }) => void | function | ❌ | undefined | | timeout | Timeout for scroll handler in ms | number | ❌ | 10 |

Supported Browsers

react-scroll-percentage-hook does not have a specific API to work with, so it supports all browsers from early versions and will support all evergreen browsers and the latest mobile browsers for iOS and Android. IE 9+ is also supported.

If you find a browser-specific problem, please report it.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

License

Code released under the MIT License.