# use-scroll-event

> A scroll event hook for React that tracks page position and detects active scrolling.

Latest version **0.0.19** (published 2020-08-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install use-scroll-event
pnpm add use-scroll-event
yarn add use-scroll-event
bun add use-scroll-event
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.19 |
| Published | 2020-08-26 |
| First published | 2020-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jeffrey Mendez |
| Maintainers | jeffmendez |
| Keywords | scroll-event, scroll-hook |

## Links

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

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.0.19 (latest) — 2020-08-26
- 0.0.18 — 2020-08-24
- 0.0.17 — 2020-08-24
- 0.0.16 — 2020-08-24
- 0.0.15 — 2020-08-24
- 0.0.14 — 2020-08-16
- 0.0.13 — 2020-08-15
- 0.0.12 — 2020-08-15
- 0.0.11 — 2020-08-15
- 0.0.10 — 2020-08-15
- 0.0.9 — 2020-08-15
- 0.0.8 — 2020-08-14
- 0.0.7 — 2020-08-14
- 0.0.6 — 2020-08-14
- 0.0.5 — 2020-08-14
- … 4 more at https://npm.io/package/use-scroll-event/versions

## README

## use-scroll-event

A scroll event hook for React that tracks page position and detects active scrolling.

## Installation Instructions

```bash
$ yarn add use-scroll-event
```

## Example

```typescript
import { useScrollEvent } from "use-scroll-event";

function App() {
  // detectScrolling: optional for scrolling detection - optimization
  const { scrolling, x, y } = useScrollEvent({ detectScrolling: true });
}
```

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