Socket
Socket
Sign inDemoInstall

menuspy

Package Overview
Dependencies
0
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

menuspy

A JavaScript library to make navigation menus highlight active item based on the scroll position.


Version published
Maintainers
1
Weekly downloads
261
decreased by-52.89%

Weekly downloads

Readme

Source

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 install 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

OptionTypeDefaultDescription
menuItemSelectorStringa[href^="#"]Menu items selector.
activeClassStringactiveClass applied on menu item relative to the currently visible section.
thresholdInteger15Ammount of space between your menu and the next section to be activated.
enableLocationHashBooleantrueEnable or disable browser's hash location change.
hashTimeoutInteger600Timeout to apply browser's hash location.
callbackFunctionfunction(currentItem) {}A function to be called every time a new menu item activates.

Keywords

FAQs

Last updated on 31 Jan 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc