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-hook

v1.0.0

Published

A simple React hook for listening to the scroll direction of a page. Provides the value as a string of either 'up' or 'down'. Defaults to up but can be configured to have a different default.

Downloads

6

Readme

useScrollDirection

This is a custom React Hook that allows you to track the direction of the user's scroll on a webpage. It provides two directions: up and down. The scroll direction is updated only when there is a significant scroll movement (at least 10 pixels).

Installation

This package is distributed via npm. You can add it to your project using:

npm install use-scroll-direction

Or if you're using Yarn:

yarn add use-scroll-direction

Usage

Here's a simple usage example:

import React from "react";
import useScrollDirection from "use-scroll-direction";

const MyComponent = () => {
  const scrollDirection = useScrollDirection();

  return (
    <div>
      <p>Current scroll direction: {scrollDirection}</p>
    </div>
  );
};

export default MyComponent;

By default, the initial direction is set to "up". However, you can specify a different initial direction ("up" or "down") if needed:

const scrollDirection = useScrollDirection({ initialDirection: "down" });

API

useScrollDirection({ initialDirection }: { initialDirection?: 'up' | 'down' })

This function is the default export of the use-scroll-direction package. It accepts an optional configuration object and returns the current scroll direction.

Arguments

  • initialDirection (optional): This optional field lets you set the initial scroll direction. It can be either "up" or "down". Defaults to "up".

Returns

  • (string): Returns a string representing the current scroll direction, either "up" or "down".

Browser Support

This hook relies on the window.pageYOffset property which is supported in all modern browsers and Internet Explorer 9+. If you need to support older browsers, you may need to include a polyfill for window.pageYOffset.

License

MIT