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

@pluginjs/scroll-spy

v0.8.11

Published

A flexible modern scroll-spy js plugin.

Downloads

70

Readme

ScrollSpy

npm package

A flexible modern scroll-spy js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/scroll-spy

NPM

npm i @pluginjs/scroll-spy

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/scroll-spy/dist/scroll-spy.js"></script>

Production:

<script src="https://unpkg.com/@pluginjs/scroll-spy/dist/scroll-spy.min.js"></script>

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import ScrollSpy from "@pluginjs/scroll-spy"

ScrollSpy.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/scroll-spy/dist/scroll-spy.css")
const ScrollSpy = require("@pluginjs/scroll-spy")

ScrollSpy.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/scroll-spy/dist/scroll-spy.css">
<script src="https://unpkg.com/@pluginjs/scroll-spy/dist/scroll-spy.js"></script>
<script>
  Pj.scrollSpy('.element', options)
</script>

API

Options

Options are called on scrollSpy instances through the scrollSpy options itself. You can also save the instances to variable for further use.

Name | Description | Default --|--|-- "selector" | You must include the href data | a "activeClass" | Current anchor avtiveItem | active "threshold" | Offset of anchor | 0 "hashTimeout" | Delay change hash | 600 "hrefFrom" | Anchor element selector | data-href "changeHash" | Whether you need to change the hash | true "cloestActive" | Find the element you want to add activeClass | parent "reference" | Anchor reference direction | top

Events

Events are called on scrollSpy instances through the scrollSpy events itself. You can also save the instances to variable for further use.

Name | Description --|-- "ready" | Gets fired when plugin is ready "destroy" | Gets fired when plugin is destroy "change" | Gets fired when plugin is changed "enable" | Gets fired when plugin is enabled "disable" | Gets fired when plugin is disabled

Methods

Methods are called on scrollSpy instances through the scrollSpy method itself. You can also save the instances to variable for further use.

Name | Description --|-- "destroy" | Destroy plugin "getCurrHref" | get the current item Id "enable" | Enabled plugin if plugin is disabled "disable" | Disable plugin

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/scroll-spy is Licensed under the GPL-v3 license.

If you want to use @pluginjs/scroll-spy project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.