# nice-spy

> nice-spy

Latest version **1.0.0** (published 2018-02-13) · appleple license · 0 weekly downloads

## Install

```sh
npm install nice-spy
pnpm add nice-spy
yarn add nice-spy
bun add nice-spy
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-02-13 |
| First published | 2018-02-13 |
| Weekly downloads | 0 |
| License | appleple |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 238.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | appleple |
| Maintainers | appleple |

## Links

- npm: https://www.npmjs.com/package/nice-spy
- Homepage: http://developer.a-blogcms.jp
- npm.io page: https://npm.io/package/nice-spy

## Dependencies (1)

- [es6-object-assign](https://npm.io/package/es6-object-assign.md) ^1.1.0

## Recent versions

- 1.0.0 (latest) — 2018-02-13

## README

# Nice Spy
A library used to update classnames of links based on scroll position

## Demos



## Installation
- [npm](https://www.npmjs.com/package/nice-spy)
- [standalone](https://raw.githubusercontent.com/appleple/nice-spy/master/js/nice-spy.js)

via npm
```shell
npm install nice-spy --save
```

or yarn

```shell
yarn add nice-spy
```

### Basic

```html
<nav>
  <ul>
    <li><a href="#section1" class="js-nicespy">section1</a></li>
    <li><a href="#section2" class="js-nicespy">section2</a></li>
    <li><a href="#section3" class="js-nicespy">section3</a></li>
  </ul>
</nav>
<section data-spy="section1">
  section1
</section>
<section data-spy="section2">
  section2
</section>
<section data-spy="section3">
  section3
</section>
```

```js
new NiceSpy('.js-nicespy', {
  offsetTop: 20,
});
```

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