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

scroll-tracker

v1.0.11

Published

scroll tracker

Downloads

15

Readme

Scroll Tracker

A small library for tracking scroll position as a percentage.

Build status

/*
 * Log to the console whenever the document.body element
 * enters one of the defined percentages in `buckets`.
 * Limit logging to happy once every 250ms.
 */
const scrollTracker = new ScrollTracker({
  element: document.body,
  buckets: [10,20,30,40,50,60,70,80,90,100],
  callback: (buckets) => console.log(buckets),
  delay: 250
});

/*
 * Destroy the logging system which was previously set up.
 */
const scrollTracker.destroy();

Table of Contents

Requirements

Scroll Tracker is a CommonJS module and available on npm. To use within a browser, a bundling tool is required (Browserify/Webpack).

Usage

Scroll Tracker is easiest to use when installed with npm:

npm install scroll-tracker

Then you can load the module into your code with a require call:

const ScrollTracker = require('scroll-tracker');

The ScrollTracker variable is a constructor.

new ScrollTracker({ element: HTMLElement, buckets: Array[Number...], callback: Function (Array[Number...]), delay: Number})

Construct a new ScrollTracker instance.

  • element is the element to track scroll percentage of (HTMLElement).
  • buckets is the set of scroll percentages to track (Array[Number...]).
  • callback is the function to be called when page has scrolled into a bucket (Function (Array[Number...])).
  • delay is the amount of milliseconds to wait between calling the callback (Number).

Example

/*
 * Log to the console whenever the document.body element
 * enters one of the defined percentages in `buckets`.
 * Limit logging to happy once every 250ms.
 */
const scrollTracker = new ScrollTracker({
  element: document.body,
  buckets: [10,20,30,40,50,60,70,80,90,100],
  callback: (buckets) => console.log(buckets),
  delay: 250
});

A ScrollTracker instance has the following methods.

.destroy()

Destroy a ScrollTracker instance, removing all event listeners added during construction of the instance.

Example

/*
 * Destroy the logging system which was previously set up.
 */
const scrollTracker.destroy();

Contributing

To contribute to Scroll Tracker, clone this repo locally and commit your code on a separate branch. Please write unit tests for your code, and run the linter before opening a pull-request:

npm test  # run all unit tests
npm run lint  # run the linter

License

Scroll Tracker is licensed under the MIT license.