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

window-scroll-manager

v1.1.4

Published

Small library that broadcasts more performant 'window-scroll' events.

Downloads

21,770

Readme

Window Scroll Manager

npm version npm downloads

Small library that broadcasts more performant window-scroll events.

Demo

Changelog

What is this?

Listening to window onscroll event is very expensive and ineffective, so this library tries to get better performance out of it.

Implementation is simple - it listens to window scroll event, but broadcasts custom window-scroll event once one per requestAnimationFrame. By my benchmarks it behaves much better.

If your event handler is doing any repaint logic, consider doing the logic it in requestAnimationFrame.

Idea came from MDN, but I tried to take it one step further by making this singleton scroll manager. It will use passive events if browser supports them.

One note for Safari, negative scroll values will be returned as 0.

Usage

Get it from npm:

npm install window-scroll-manager

Import it and use it:

import ScrollManager from 'window-scroll-manager'

const sm = new ScrollManager();

console.log(sm.getScrollPosition());
// -> { scrollPositionX: 0, scrollPositionY: 0 }

window.addEventListener('window-scroll', function(e) {
  console.log('Vertical scroll position is: ' + e.detail.scrollPositionY);
  console.log('Horizontal scroll position is: ' + e.detail.scrollPositionX);

  requestAnimationFrame(function() {
    // repaint logic goes here
    // example:
    // rotateDiv.style.transform = 'rotate(' + e.detail.scrollPositionY / 2 + 'deg)';
  });
});

API

  • getScrollPosition() - returns current window scroll position object.
    {
      scrollPositionX: 0,
      scrollPositionY: 100,
    }
  • removeListener() - reduces internal reference counter by one, and if it reaches 0 destroys the instance. Reference counter is increased every time new ScrollManager is called. For example, this is useful when scroll manager is used in React high order component (to track if any component is still using it). Use with caution.
  • destroy() - destroys the singleton instance and removes scroll listener. Use with caution, call removeListener do this for you.