# @render-props/size-observer

> A state container which provides an interface for constantly querying for changes to the size of the referenced element in its child function.

Latest version **0.1.18** (published 2019-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @render-props/size-observer
pnpm add @render-props/size-observer
yarn add @render-props/size-observer
bun add @render-props/size-observer
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.18 |
| Published | 2019-03-20 |
| First published | 2018-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 11.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 36 |
| Author | Jared Lunde |
| Maintainers | jaredlunde |
| Keywords | react, render props, function as child, hoc, state container, size observer, observer |

## Links

- npm: https://www.npmjs.com/package/@render-props/size-observer
- Repository: https://github.com/jaredlunde/render-props/tree/master/packages/size-observer
- npm.io page: https://npm.io/package/@render-props/size-observer

## Dependencies (3)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.4.0
- [@render-props/rect](https://npm.io/package/@render-props/rect.md) ^0.1.16
- [@render-props/utils](https://npm.io/package/@render-props/utils.md) ^0.2.1

## 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.1.18 (latest) — 2019-03-20
- 0.1.17 — 2019-01-31
- 0.1.16 — 2019-01-12
- 0.1.15 — 2018-12-29
- 0.1.14 — 2018-09-11
- 0.1.13 — 2018-09-10
- 0.1.12 — 2018-09-06
- 0.1.11 — 2018-08-21
- 0.1.10 — 2018-08-20
- 0.1.9 — 2018-08-18
- 0.1.8 — 2018-08-18
- 0.1.7 — 2018-08-18
- 0.1.6 — 2018-05-15
- 0.1.5 — 2018-03-26
- 0.1.4 — 2018-03-22
- … 4 more at https://npm.io/package/@render-props/size-observer/versions

## README

# SizeObserver
A state container which provides an interface for constantly querying for
changes to the size of the referenced element in its child function.

### Installation
```yarn add @render-props/size-observer``` or ```npm i @render-props/size-observer```

## Usage
```js
import SizeObserver from '@render-props/size-observer'

function SizeObservedDiv (props) {
  return (
    <SizeObserver every={100/**queries every hundred milliseconds*/}>
      ({sizeRef, width, height, recalcSize}) => (
        <div ref={sizeRef}>
          <div>
            width: {width}
          </div>
          <div>
            height: {height}
          </div>
        </div>
      )
    </SizeObserver>
  )
}
```

____

## Props
- `every {number} {default: 1000/60}`
  - the size observer will re-evaluate the size every `@every` milliseconds
- `useBoundingRect {bool} {default: false}`
  - if `true` the element will be measured with `getBoundingClientRect`
    instead of `offsetWidth` and `offsetHeight`
- `onChange {function<{width, height}>}`
  - called each time the width or height changes

## Render Props

#### Ref
- `sizeRef`
  - This `ref` must be provided to whatever element you are trying to observe the
    the size of. e.g. `<div ref={sizeRef}>`

#### Methods
- `recalcSize` `()`
  - forces the component to re-calculate the size of the element

#### State
- `width {number}`
  - the `offsetWidth` or `getBoundingClientRect().width` of the element
- `height {number}`
  - the `offsetHeight` or `getBoundingClientRect().height` of the element

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