1.0.2 • Published 7 years ago
nav-scroll-spy v1.0.2
nav-scroll-spy
Simple ES6 Scroll Spy Class
Example: komock.github.io/nav-scroll-spy
Install
npm i --save-dev nav-scroll-spy
Usage
// Absolute path to module 'node_modules/nav-scroll-spy/src/js/nav-scroll-spy.js'
import NavScrollSpy from 'nav-scroll-spy';
let spy = new NavScrollSpy();
spy.init();
Markup example
<nav>
<ul>
<li><a href="#section-1">section-1</a></li>
<li><a href="#section-2">section-2</a></li>
</ul>
</nav>
Options
Option | Type | Default | Description |
---|---|---|---|
offset | number | 0 | Scroll offset |
currentClass | string | 'active' | Element class for current navigation item (or items). Class will be applied to link parent. |
selector | string (html) | 'nav ahref*="#"' | Selector for navigation links |
throttle | number | 100 | Throttling window events (scroll and resize) to improve performance |
Features
- Fast and lightweight
- No jQuery
- ES6 ready