# @reach/observe-rect

> Observe the Rect of a DOM element.

Latest version **1.2.0** (published 2020-06-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @reach/observe-rect
pnpm add @reach/observe-rect
yarn add @reach/observe-rect
bun add @reach/observe-rect
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-06-22 |
| First published | 2018-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 28.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 397 |
| Author | React Training |
| Maintainers | blainekasten, chancestrickland, mjackson, ryanflorence |

## Links

- npm: https://www.npmjs.com/package/@reach/observe-rect
- Repository: https://github.com/reach/observe-rect
- npm.io page: https://npm.io/package/@reach/observe-rect

## Recent versions

- 1.2.0 (latest) — 2020-06-22
- 1.1.0 — 2020-03-13
- 1.0.5 — 2020-01-10
- 1.0.4 — 2020-01-08
- 1.0.3 — 2018-06-12
- 1.0.2 — 2018-06-03
- 1.0.1 — 2018-06-03
- 1.0.0 — 2018-06-02

## README

<p align="center">
  <a href="https://reach.tech">
    <img alt="Reach observeRect" src="./logo.png" width="400">
  </a>
</p>

<p align="center">
  Observe the rect of a DOM element.
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/@reach/observe-rect"><img src="https://img.shields.io/npm/v/@reach/observe-rect.svg?style=flat-square"></a>
  <a href="https://www.npmjs.com/package/@reach/observe-rect"><img src="https://img.shields.io/npm/dm/@reach/observe-rect.svg?style=flat-square"></a>
</p>

<p align="center">
  <img src="./demo.gif" alt="Demo"/>
</p>

## Installation

```
npm install @reach/observe-rect
# or
yarn add @reach/observe-rect
```

## Usage

```js
import observeRect from "@reach/observe-rect";

let node = document.getElementById("some-node");

let rectObserver = observeRect(node, rect => {
  console.log("left", rect.left);
  console.log("top", rect.top);
  console.log("height", rect.height);
  console.log("width", rect.width);
});

// start observing
rectObserver.observe();

// stop observing
rectObserver.unobserve();
```

## About

A lot of things can change the position or size of an element, like scrolling, content reflows and user input. This utility observes and notifies you when your element's rect changes.

## Legal

MIT License
Copyright (c) 2018-present, Ryan Florence

---
_Source: https://npm.io/package/@reach/observe-rect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._