# local-scroll

> This plugin adds animated scrolling to local links. jQuery is required.

Latest version **1.0.1** (published 2016-03-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install local-scroll
pnpm add local-scroll
yarn add local-scroll
bun add local-scroll
```

## 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.1 |
| Published | 2016-03-07 |
| First published | 2016-03-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | daandd |

## Links

- npm: https://www.npmjs.com/package/local-scroll
- npm.io page: https://npm.io/package/local-scroll

## Recent versions

- 1.0.1 (latest) — 2016-03-07
- 1.0.0 — 2016-03-07

## README

# Local scroll

This plugin adds animated scrolling to local links. jQuery is required.

## Usage

```
npm install --save local-scroll
```

```js
import LocalScroll from 'local-scroll';
new LocalScroll({
  // Options
  selector: "a[href^=#]"
});
```

## Options

```js
{
  selector: "[data-scroll]",  // Choose which items get triggered
  offset: 0,                  // Offset scroll in pixels
  duration: 400               // Animation duration
}
```

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