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

butter-scroll

v0.0.1-alpha.8

Published

Simple, effective, progressively-enhanced, buttery-smooth scrolling.

Downloads

38

Readme

Butter Scroll

Simple, effective, progressively-enhanced, buttery-smooth scrolling.

Warning

This project is still in its very early stages. If you're not willing to read the source or come up with clever workarounds for bizarre behavior, it's probably not for you.

Installation

via npm

npm install butter-scroll --save

Other required libraries

The long-term goal is to remove these dependencies, but for now Butter Scroll won't work if they aren't loaded.

Other optional (but recommended) libraries

If a Modernizr build with the correct options is available, Butter Scroll will use that to progressively enhance for browsers that fully support it, and retain normal scrolling for those that don't.

If Modernizr is not found, Butter Scroll will assume full browser support.

Your Modernizr build should include the following:

  • csstransforms
  • csstransforms3d
  • Modernizr.prefixed()

Or just use this Modernizr build

Setup

HTML

The class names used here don't need to match exactly this example, but they do need to exactly match the names used in your styles and initialization javascript.

<div class="outer-container js-outer-container">
  <div class="inner-container js-inner-container">
    …
  </div>
</div>

Optional Parallax

To enable parallax for individual HTML elements, just give them a data-depth attribute with a value between 0 (farthest away) and 10 closest.

<div data-depth="3"></div>
<div data-depth="7"></div>

Styles

There are a few minimal CSS styles that you need to add to the above elements.

.inner-container {
  overflow: hidden;
}

Javascript

new ButterScroll({
  $containerEl: $('.js-outer-container'),
  $elToScroll: $('.js-inner-container'),
  scrollEase: 0.15, // optional
  maxDepthOffset: 500 // optional
});

Dev

npm start: Automatically builds on file change and starts a live reload server with an example at http://localhost:3000/example/

npm run build: Builds production-ready files