# @uplift-ltd/use-on-page-scroll

> use-on-page-scroll

Latest version **2.1.1** (published 2026-02-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uplift-ltd/use-on-page-scroll
pnpm add @uplift-ltd/use-on-page-scroll
yarn add @uplift-ltd/use-on-page-scroll
bun add @uplift-ltd/use-on-page-scroll
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2026-02-20 |
| First published | 2022-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Uplift Agency Ltd. |
| Maintainers | mariusc23 |

## Links

- npm: https://www.npmjs.com/package/@uplift-ltd/use-on-page-scroll
- Repository: https://github.com/uplift-ltd/nexus
- Homepage: https://nexus.uplift.ltd/docs/packages/use-on-page-scroll
- Issues: https://github.com/uplift-ltd/nexus/issues?q=is:open+is:issue+label:use-on-page-scroll
- npm.io page: https://npm.io/package/@uplift-ltd/use-on-page-scroll

## Recent versions

- 2.1.1 (latest) — 2026-02-20
- 2.0.0-alpha.2 (prerelease) — 2023-04-18
- 2.1.0 — 2026-02-03
- 2.0.1 — 2025-06-21
- 2.0.0 — 2023-11-06
- 2.0.0-alpha.1 — 2023-04-18
- 2.0.0-alpha.0 — 2023-04-18
- 1.2.4 — 2023-02-06
- 1.2.4-alpha.0 — 2023-02-06
- 1.2.3 — 2022-12-05
- 1.2.3-alpha.1 — 2022-12-05

## README

# @uplift-ltd/use-on-page-scroll

## Installation

```sh
npm i --save @uplift-ltd/use-on-page-scroll
```

## API

### useOnPageScroll

Hook to handle scroll up/down events. Returns current and previous y position. Cleans up after
itself.

```ts
import { useOnPageScroll } from "@uplift-ltd/use-on-page-scroll";

useOnPageScroll({
  onScrollUp: ([newYPosition, lastYPosition]) => {
    console.log(newYPosition, lastYPosition);
  },
  onScrollDown: ([newYPosition, lastYPosition]) => {
    console.log(newYPosition, lastYPosition);
  },
});
```

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