# eased-scroll

> Listen to eased window scroll.

Latest version **0.1.2** (published 2022-07-13) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2022-07-13 |
| First published | 2020-09-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Filip Chalupa |
| Maintainers | onset |
| Keywords | scroll, easing, listener, typescript |

## Links

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

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2022-07-13
- 0.1.1 — 2022-07-13
- 0.1.0 — 2020-11-05
- 0.0.3 — 2020-09-04
- 0.0.2 — 2020-09-04
- 0.0.1 — 2020-09-04

## README

# Eased scroll [![npm](https://img.shields.io/npm/v/eased-scroll.svg)](https://www.npmjs.com/package/eased-scroll) [![Dependencies](https://img.shields.io/david/FilipChalupa/eased-scroll.svg)](https://www.npmjs.com/package/eased-scroll?activeTab=dependencies) ![npm type definitions](https://img.shields.io/npm/types/eased-scroll.svg)

Listen to eased window scroll. [Demo](https://filipchalupa.cz/eased-scroll/demo.html).

![UI example](https://raw.githubusercontent.com/FilipChalupa/eased-scroll/main/screencast.gif)

## Installation

```bash
npm install eased-scroll
```

## How to use

### JavaScript:

```javascript
import { easedScroll } from 'eased-scroll'

easedScroll(200).addListener((value) => {
	console.log('Actual value', window.scrollY)
	console.log('Smooth value', value)
})
```

For more advanced cases you can use methods `removeListener` and `getValue` too.

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