# react-viewport-observer

> A declarative way to listen to scroll and resize events of the viewport

Latest version **0.0.5** (published 2016-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-viewport-observer
pnpm add react-viewport-observer
yarn add react-viewport-observer
bun add react-viewport-observer
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2016-10-24 |
| First published | 2016-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | hssrrw |
| Maintainers | hssrrw |
| Keywords | react, viewport, observer, scroll, resize |

## Links

- npm: https://www.npmjs.com/package/react-viewport-observer
- Repository: https://github.com/hssrrw/react-viewport-observer
- Homepage: https://github.com/hssrrw/react-viewport-observer#readme
- Issues: https://github.com/hssrrw/react-viewport-observer/issues
- npm.io page: https://npm.io/package/react-viewport-observer

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.16.4

## 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

- 0.0.5 (latest) — 2016-10-24
- 0.0.4 — 2016-10-24
- 0.0.3 — 2016-10-23
- 0.0.2 — 2016-10-23
- 0.0.1 — 2016-10-23

## README

React Viewport Observer
=========

Declarative way to listen to `scroll` and `resize` events of the viewport.

## Installation

```
npm install --save react-viewport-observer
```

or

```
yarn add react-viewport-observer
```

## Why

Typcal use cases are scroll controlled effects and viewport size monitoring.

This project prevents from creating multiple event listeners, allowing to 'subscribe' to viewport events in a declarative way.

## Usage

```js
// App.js
import { ViewportStore, ViewportBroadcaster } from 'react-viewport-observer';

const viewportStore = new ViewportStore();
const App = () =>
	<ViewportBroadcaster store={viewportStore}>
		{/* some children */}
	</ViewportBroadcaster>;
```
```js
// ScrollProgress.js
import { ViewportSubscriber } from 'react-viewport-observer';

const ScrollProgress = () =>
	<ViewportSubscriber fields={['scrollPercent']}>
		{/* fields can be: scrollY, scrollPercent, width, height */}
		{({ scrollPercent }) =>
			{/* some fancy scroll effect like scaling :D */}
			<div style={{ transform: `scaleX(${scrollPercent / 100})` }} />}
	</ViewportSubscriber>;
```


## License

MIT

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