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

@sidsbrmnn/scrollspy

v1.1.0

Published

A simple lightweight JavaScript library without jQuery or any other dependencies to handle scroll spying on static webpages.

Downloads

4,783

Readme

@sidsbrmnn/scrollspy

npm version

A simple lightweight JavaScript library without jQuery or any other dependencies to handle scroll spying on static webpages.

Install

  1. via NPM

    Install it using npm

    npm install --save @sidsbrmnn/scrollspy
  2. Use the minified script from unpkg.com

    <script src="https://unpkg.com/@sidsbrmnn/[email protected]/dist/scrollspy.min.js"></script>

Usages

Easy for using, syntax just like this:

scrollSpy(menu, options)

This little plugin will add active class into your existing menu item when you scroll your page to a matched section by ID. If you are giving it a try, make sure that you:

  1. Added CSS for active class in your menu item. Because, this plugin do NOT include CSS.

  2. Create your sections.

    Example: <section id="first-section">...</section>

  3. Added an attribute which is an section ID into your menu items. Default is href.

    Example: "href"="#first-section". You also replace href with the other name by hrefAttribute in options.

Arguments

  1. The menu is query selector to your menu. It is string or HTMLElement instance.

  2. The options is optional. It is type of object which contains properties below:

| Name | Type | Default | Description | |--------------------|:---------|:--------------|:----------------------------------------------------------------------| | sectionSelector | string | section | Query selector to your sections | | targetSelector | string | a | Element will be added active class | | offset | number | 0 | Offset number | | hrefAttribute | string | href | The menu item's attribute name which contains section ID | | activeClass | string | active | Active class name will be added into targetSelector | | isActive | function | null | A callback method that's called with the current menuItem and section |

ES6

import scrollSpy from '@sidsbrmnn/scrollspy'

const options = {
    sectionSelector: 'section',  // Query selector to your sections
    targetSelector: '.nav-link', // Query selector to your elements that will be added `active` class
    offset: 100                  // Menu item will active before scroll to a matched section 100px
}

// Initialize
scrollSpy(document.getElementById('navMain'), options)

// Shorter way
scrollSpy('#navMain', options)

Script tag

<script src="/path/to/dist/scrollspy.min.js"></script>
<script>
    window.onload = function () {
        scrollSpy('#navMain', {
            sectionSelector: 'section',
            targetSelector: '.nav-link',
            offset: 100
        });
    }

</script>

Licence

MIT