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

fws-scrollnav

v1.20.0

Published

A sub navigation component generated from page content.

Downloads

7

Readme

Scroll-Nav

This module searches website content for headings and creates an ordered list to provide within-page navigation links. The module makes no stylistic assumptions; you'll have to bring your own CSS. This code is based on scrollnav by jimmynotjim.

Development

To ease development we use npm scripts to compile JS with browserify/watchify:

First, install the project dependencies:

npm install

To quickly build the project and watch files for changes during development:

npm run watchify

To build a production ready version of the app use:

npm run build

To visualize packages contributing to bundle file size:

npm run inspect:bundle

Options

  • headingTag (string): The HTML tag used to generate the scroll nav list (default: 'h2')
  • content (selector or DOM node): The content area that should be searched for heading tags (default: document.body)
  • target (selector or DOM node): The location where the scroll nav list should be appended (default: document.body)
  • fixedClass (string): The class appended to the nav as it begins to scroll out of view (default: 'fixed'),
  • fixedMargin (integer): The top dimension offset used to determine when to append the 'fixed' class (default: 40),
  • offset (integer): How much top margin is left when scrolling to a heading (default: 40)

License

This project is based on scrollnav by jimmynotjim, which carries an MIT License.