# react-scroll-level

> It gets scrolled percentage of document height or width.

Latest version **1.0.4** (published 2022-02-05) · 0 weekly downloads

## Install

```sh
npm install react-scroll-level
pnpm add react-scroll-level
yarn add react-scroll-level
bun add react-scroll-level
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-02-05 |
| First published | 2022-02-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Emre Işık |
| Maintainers | emreisik |
| Keywords | react, scroll, level, scroll percentage, scroll level, scroll percentage of document height, scroll percentage of document width, scroll percentage of window height, scroll percentage of window width, scroll percentage of document height or width, scroll percentage of window height or width, scroll percentage finder, scroll percentage finder for react, scroll percentage finder for reactjs |

## Links

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

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2022-02-05
- 1.0.3 — 2022-02-05
- 1.0.2 — 2022-02-05
- 1.0.0 — 2022-02-05

## README

# useScrollLevel - a custom React hook
A lightweight (1 kB) package to easily track scroll percentage in React.js

## Install
`npm install react-scroll-level`

## Example 
```js
import React from 'react'
import { useScrollLevel } from 'react-scroll-level'

function App() {
  const { scrollHeight, scrollWidth } = useScrollLevel();
  console.log('scrollHeight:', scrollHeight); 
  console.log('scrollWidth:', scrollWidth);
}
```

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