# es6-scroll-to

> Vanilla JavaScript micro function for animated scrolling written in ES6

Latest version **1.1.2** (published 2018-06-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install es6-scroll-to
pnpm add es6-scroll-to
yarn add es6-scroll-to
bun add es6-scroll-to
```

## 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.1.2 |
| Published | 2018-06-30 |
| First published | 2018-06-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 46.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | janrembold |
| Maintainers | janrembold |

## Links

- npm: https://www.npmjs.com/package/es6-scroll-to
- Repository: https://github.com/janrembold/es6-scroll-to
- Homepage: https://github.com/janrembold/es6-scroll-to#readme
- Issues: https://github.com/janrembold/es6-scroll-to/issues
- npm.io page: https://npm.io/package/es6-scroll-to

## Recent versions

- 1.1.2 (latest) — 2018-06-30
- 1.1.1 — 2018-06-28
- 1.1.0 — 2018-06-27
- 1.0.1 — 2018-06-26
- 1.0.0 — 2018-06-26

## README

# es6-scroll-to
Vanilla JavaScript micro function for animated scrolling written in ES6. Supports jQuery easing functions. 

See demo here: https://janrembold.github.io/es6-scroll-to/example/

## Installation

```
yarn add es6-scroll-to

// or

npm install es6-scroll-to
```

## Usage

```javascript
import {animatedScrollTo} from 'es6-scroll-to';

// shorthand - setting target Y-Offset directly
animatedScrollTo(600);

// ...equals to 
animatedScrollTo({
    to: 600
});

// change animation duration [in ms]
animatedScrollTo({
    duration: 1000,
    to: 600
});

// change easing functions, see https://github.com/janrembold/es6-easings
import {easeInQuint} from 'es6-easings';
animatedScrollTo({
    easing: easeInQuint,
    to: 600
});

```

## Options

The `animatedScrollTo` method takes a single parameter that might be an `Object` or the target Y-Offset as positive `Integer`.

```
{
    to: [Number], // required
    duration: [Integer], // optional, defaults to 400
    easing: [function] // optional, defaults to 'easeOutQuad'    
}
```

### `to` (required)
The target Y-Offset as positive `Integer`

### `duration` (optional)
The animation duration in milliseconds. Defaults to `400`

### `easing` (optional)
The easing function that is used to calculate the animation. See https://github.com/janrembold/es6-easings for easing variations. Defaults to `easeOutQuad`

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