# ngx-neatscrollspy

> Plugin to create a smooth and custom scrollspy experience in your application

Latest version **1.0.1** (published 2019-05-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install ngx-neatscrollspy
pnpm add ngx-neatscrollspy
yarn add ngx-neatscrollspy
bun add ngx-neatscrollspy
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-05-16 |
| First published | 2019-05-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.3 MB |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jonathan Ijeh |
| Maintainers | captajo |
| Keywords | Scrollspy, Angular |

## Links

- npm: https://www.npmjs.com/package/ngx-neatscrollspy
- Repository: https://github.com/captajo/ngx-neatscrollspy
- Homepage: https://github.com/captajo/ngx-neatscrollspy#readme
- Issues: https://github.com/captajo/ngx-neatscrollspy/issues
- npm.io page: https://npm.io/package/ngx-neatscrollspy

## Dependencies (2)

- [rxjs](https://npm.io/package/rxjs.md) ^6.5.2
- [@angular/core](https://npm.io/package/@angular/core.md) ^7.2.15

## Alternatives

- [pagerjs](https://npm.io/package/pagerjs.md) — 60 weekly downloads
- [whistle.savefor-mock](https://npm.io/package/whistle.savefor-mock.md) — 4 weekly downloads
- [@anil-labs/factory](https://npm.io/package/@anil-labs/factory.md) — 0 weekly downloads
- [@massiv-oss/grpc-fake-server](https://npm.io/package/@massiv-oss/grpc-fake-server.md) — 0 weekly downloads
- [@buoy-gg/location](https://npm.io/package/@buoy-gg/location.md) — 0 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2019-05-16
- 1.0.0 — 2019-05-15

## README

# ngx-neatscrollspy
This is an extension for Angular 2+ application, for smooth scroll-spy experience

# Installation
Install this extension from npm repository using

      - npm i ngx-neatscrollspy --save

# Setting Up
Setup in your angular project by importing, `NeatScrollspyModule` into your `app.module.ts`

          import { NeatScrollspyModule } from 'ngx-neatscrollspy'; 

          ...... 

          @NgModule({
            declarations: [ ... ],
            imports: [
              ....
              NeatScrollspyModule,
            ]
          })


# Getting Started
NeatScrollspy can be used real quick and easy, with just two basics. 

1. Set the point in your HTML you want to monitor scroll 

        <div [neatScrollSpy]="{ id: 'uniqueID', selector: 'mains'}">
              // Place code you want to spy on scroll here with assigned selector as class
              // Example <h2 class="mains"></h2>
        </div>
              
2. Set where to display scroll options and responses 

        <neat-scrollspy-template [neatScrollspyOptions]="{ id: 'uniqueID' }"></neat-scrollspy-template>

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