# @nextui-org/use-scroll-position

> Provides the logic to control the scroll over an element

Latest version **2.1.1** (published 2024-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nextui-org/use-scroll-position
pnpm add @nextui-org/use-scroll-position
yarn add @nextui-org/use-scroll-position
bun add @nextui-org/use-scroll-position
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2024-12-06 |
| First published | 2023-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Junior Garcia |
| Maintainers | juniorgarciadev |
| Keywords | use-scroll-position |

## Links

- npm: https://www.npmjs.com/package/@nextui-org/use-scroll-position
- Repository: https://github.com/nextui-org/nextui
- Homepage: https://nextui.org
- Issues: https://github.com/nextui-org/nextui/issues
- npm.io page: https://npm.io/package/@nextui-org/use-scroll-position

## Recent versions

- 2.1.1 (latest) — 2024-12-06
- 0.0.0-canary-20241206144245 (canary) — 2024-12-06
- 2.0.10-beta.5 (beta) — 2024-11-28
- 0.0.0-dev-v2-20240416125016 (dev-v2) — 2024-04-16
- 2.1.0 — 2024-12-06
- 0.0.0-canary-20241205201328 — 2024-12-05
- 0.0.0-canary-20241205120225 — 2024-12-05
- 0.0.0-canary-20241205115555 — 2024-12-05
- 0.0.0-canary-20241205024636 — 2024-12-05
- 0.0.0-canary-20241204224020 — 2024-12-04
- 0.0.0-canary-20241204223333 — 2024-12-04
- 0.0.0-canary-20241204222550 — 2024-12-04
- 0.0.0-canary-20241204130109 — 2024-12-04
- 0.0.0-canary-20241204110242 — 2024-12-04
- 0.0.0-canary-20241204105441 — 2024-12-04
- … 187 more at https://npm.io/package/@nextui-org/use-scroll-position/versions

## README

# @nextui-org/use-scroll-position

A Quick description of the component

> This is an internal utility, not intended for public usage.

## Installation

```sh
yarn add @nextui-org/use-scroll-position
# or
npm i @nextui-org/use-scroll-position
```

## Contribution

Yes please! See the
[contributing guidelines](https://github.com/nextui-org/nextui/blob/master/CONTRIBUTING.md)
for details.

## License

This project is licensed under the terms of the
[MIT license](https://github.com/nextui-org/nextui/blob/master/LICENSE).

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