@pluginjs/scroll-spy NPM

ScrollSpy

A flexible modern scroll-spy js plugin.

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 purchase@thecreation.co.