A JavaScript library to make navigation menus highlight the item based on currently in view section.
JavaScript
Latest commit ba160b7 Jan 31, 2018
lcdsantos Merge pull request #11 from qathom/master
Add yarn command in Readme
Permalink
Failed to load latest commit information.
dist v1.3.0 Jan 31, 2018
examples Fixed lavalamp example for the new api Nov 14, 2017
src Sorting scrollItems by the offset value Jan 31, 2018
test Initial commit Sep 25, 2016
.eslintrc Initial commit Sep 25, 2016
.gitattributes Fix undefined error Aug 4, 2017
.gitignore Initial commit Sep 25, 2016
LICENSE Initial commit Sep 25, 2016
README.md Update README.md Jan 31, 2018
bower.json v1.3.0 Jan 31, 2018
karma.conf.js Initial commit Sep 25, 2016
package-lock.json 1.3.0 Jan 31, 2018
package.json 1.3.0 Jan 31, 2018
rollup.config.js Updated rollup config Jan 31, 2018

README.md

MenuSpy

A JavaScript library to make navigation menus highlight the item based on currently in view section.

  • No dependencies
  • Easy to use
  • Lightweight and fast

Usage

Include MenuSpy

<script src="menuspy.js"></script>

MenuSpy will be available in the global scope.

Or install via NPM/Yarn and require as a module

NPM

npm install menuspy

Yarn

yarn add menuspy
var MenuSpy = require('menuspy');

Initialize the plugin on your menu element

<header id="main-header">
  <nav>
    <ul>
      <li><a href="#features">Features</a></li>
      <li><a href="#usage">Usage</a></li>
      <li><a href="#options">Options</a></li>
      <li><a href="#examples">Examples</a></li>
    </ul>
  </nav>
</header>

You can also use data-target on the anchor element with a selector. Example:

<a href="#anything" data-target="selector">Anything</a>
var elm = document.querySelector('#main-header');
var ms = new MenuSpy(elm);

The MenuSpy() constructor accepts two arguments: the container element and an options object.

Options

Option Type Default Description
menuItemSelector String a[href^="#"] Menu items selector.
activeClass String active Class applied on menu item relative to the currently visible section.
threshold Integer 15 Ammount of space between your menu and the next section to be activated.
enableLocationHash Boolean true Enable or disable browser's hash location change.
hashTimeout Integer 600 Timeout to apply browser's hash location.
callback Function function(currentItem) {} A function to be called every time a new menu item activates.