# storm-hysteresis-nav

> Cursor-predicting hover menu

Latest version **0.2.2** (published 2018-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install storm-hysteresis-nav
pnpm add storm-hysteresis-nav
yarn add storm-hysteresis-nav
bun add storm-hysteresis-nav
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2018-02-14 |
| First published | 2017-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 86.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | stormid |
| Maintainers | mjbp |
| Keywords | stormid, navigation, hover, component, ui, predictive |

## Links

- npm: https://www.npmjs.com/package/storm-hysteresis-nav
- Repository: https://github.com/mjbp/storm-hysteresis-nav
- Homepage: https://github.com/mjbp/storm-hysteresis-nav#readme
- Issues: https://github.com/mjbp/storm-hysteresis-nav/issues
- npm.io page: https://npm.io/package/storm-hysteresis-nav

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2018-02-14
- 0.2.1 — 2018-01-05
- 0.2.0 — 2017-09-19
- 0.1.1 — 2017-04-11
- 0.1.0 — 2017-04-11

## README

# Hysteresis nav

[![Build Status](https://travis-ci.org/mjbp/storm-hysteresis-nav.svg?branch=master)](https://travis-ci.org/mjbp/storm-hysteresis-nav)
[![codecov.io](http://codecov.io/github/mjbp/storm-hysteresis-nav/coverage.svg?branch=master)](http://codecov.io/github/mjbp/storm-hysteresis-nav?branch=master)
[![npm version](https://badge.fury.io/js/storm-hysteresis-nav.svg)](https://badge.fury.io/js/storm-hysteresis-nav)

Cursor-predicting hover menu

## Example
[https://mjbp.github.io/storm-hysteresis-nav](https://mjbp.github.io/storm-hysteresis-nav)
    

## Usage
JS
```
npm i -S storm-hysteresis-nav
```
either using es6 import
```
import HysteresisMenu from 'storm-hysteresis-nav';

HysteresisMenu.init('.js-nav');
```
aynchronous browser loading (use the .standalone version in the /dist folder)
```
import Load from 'storm-load';

Load('/content/js/async/storm-hysteresis-nav.standalone.js')
    .then(() => {
        StormHysteresisMenu.init('.js-nav');
    });
```

## Options
```
    {
        delay: 400,
        animationDelay: 160,
        itemSelector: '.js-hysteresis-nav-item',
        animatingClassName: 'is--animating',
        activeClassName: 'is--active',
        hoverClass: '',
        tolerance: 75,
        callback: null
    }
```

## Tests
```
npm run test
```

## Browser support
This is module has both es6 and es5 distributions. The es6 version should be used in a workflow that transpiles.

This module depends upon Object.assign, element.classList, and Promises, available in all evergreen browsers. ie9+ is supported with polyfills, ie8+ will work with even more polyfills for Array functions and eventListeners.

## Dependencies
None

## License
MIT

## Credit
Inspired by http://bjk5.com/post/44698559168/breaking-down-amazons-mega-dropdown

---
_Source: https://npm.io/package/storm-hysteresis-nav · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
