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-use-sticky-scroll

v0.0.2

Published

A React hook to help you set up 'sticky scroll' behavior.

Downloads

3

Readme

useStickyScroll

A simple React hook to help you set up "sticky scroll" behavior. "sticky scroll" is a technique in which an element switches between relative and fixed positioning as you scroll past it so that it remains at the top of your screen or the container while you scroll through the rest of the content.

Version npm bundle size

Description

position: sticky is support but it's browser support is very limited. This hook provides a workable solution that does not rely on the experimental css feature for your React application.

Install

npm install react-use-sticky-scroll

yarn add react-use-sticky-scroll

API

The module exports a single function useStickyScroll.

The hook accepts a single argument which is an options object:

element: a React.MutableRefObject that contains a reference to the element that you want to stick

container: a React.MutableRefObject that contains a reference to a scrollable ancestor of the sticky element. The sticky element will fix itself to the top of this container once the container's scroll height reaches the element.

stickyClass: an optional string containing a css class to apply to the sticky element once its positioning has become fixed.

Example

There is a runnable example located in the /example folder in the repository. To run it make sure to clone the repo and install all the dependencies. You can spin up the example with npm run example.

For convenience here is the usage of the hook:

import { useStickyScroll } from "react-use-sticky-scroll"
import { useRef } from "react"

export const App = () => {
    const stickyHeader = useRef<HTMLDivElement>(null)
    const content = useRef<HTMLElement>(null)

    useStickyScroll({
        element: stickyHeader,
        container: content,
        stickyClass: "stickyContent--stuck"
    })

    return (
        <div>
            <header>
                <h2>useStickyScroll example</h2>
            </header>
            <section ref={content}>
                <h4>Article</h4>
                <p>notice how the div below sticks to the top of the scrollable container as the scroll height passes it</p>
                <div ref={stickyHeader} className="stickyContent">Sticky Content!</div>
                <p className="longContent">
                    some loooooong content
                </p>
            </section>
            <footer/>
        </div>
    )
}
html {
    background-color: azure;
}

section {
    width: 500px;
    overflow: auto;
    border: solid 1px darkslategray;
    padding-top: 25px;
    padding-left: 25px;
}

.stickyContent {
    font-weight: bold;
}

.stickyContent--stuck {
    background-color: azure;
}

.longContent {
    height: 300px;
}