This package has been deprecated

Author message:

WARNING: This project has been renamed to storm-scroll-spy. Install using storm-scroll-spy instead

Storm ScrollSpy

Usage

npm i -S storm-scrollspy

var ScrollSpy = require('storm-scrollspy')
ScrollSpy.init('.js-scrollspy');

<nav class="js-scrollspy">
    <a href="#section1">Section 1</a>
    <a href="#section2">Section 2</a>
    <a href="#section3">Section 3</a>
</nav>
<section id="section1"></section>
<section id="section2"></section>
<section id="section3"></section>

Options

Defaults:

{
    offset: 0,
    activeClassName: 'active',
    callback: null
}

Credits

Adapted from an initial fork of cferdinandi's gumshoe