# simple-element-resize-detector

> Observes resizing of an element using a hidden iframe.

Latest version **1.3.0** (published 2019-06-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-element-resize-detector
pnpm add simple-element-resize-detector
yarn add simple-element-resize-detector
bun add simple-element-resize-detector
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2019-06-13 |
| First published | 2017-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/simple-element-resize-detector) |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 189 |
| Author | Jason Miller |
| Maintainers | developit, nekr |
| Keywords | element resize, resize observer, ResizeObserver, element size |

## Links

- npm: https://www.npmjs.com/package/simple-element-resize-detector
- Repository: https://github.com/developit/simple-element-resize-detector
- Homepage: https://github.com/developit/simple-element-resize-detector#readme
- Issues: https://github.com/developit/simple-element-resize-detector/issues
- npm.io page: https://npm.io/package/simple-element-resize-detector

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2019-06-13
- 1.2.0 — 2018-08-31
- 1.1.1 — 2018-08-31
- 1.1.0 — 2017-01-04
- 1.0.1 — 2017-01-04
- 1.0.0 — 2017-01-04

## README

# simple-element-resize-detector [![NPM](https://img.shields.io/npm/v/simple-element-resize-detector.svg?style=flat)](https://www.npmjs.org/package/simple-element-resize-detector)


Observes resizing of an element using a hidden iframe.

[**JSFiddle Demo**](https://jsfiddle.net/developit/62Lgh3wz/)

## Installation

```sh
npm i -S simple-element-resize-detector
```


## Usage

```js
import observeResize from 'simple-element-resize-detector';

// any DOM element that can have children
let element = document.createElement('div');

// listen for resize
observeResize(element, () => {
	console.log('new size: ', {
		width: element.clientWidth,
		height: element.clientHeight
	});
});
```

To stop observing resize events, simply remove the returned detector frame:

```js
let detector = observeResize(el, () => {});

detector.remove();

// or, for better browser compatibility:
// detector.parentNode.removeChild(detector)
```

## Notes

* `element` passed to `observeResize()` must have `position: relative` style to be correctly observed, otherwise nearest relative ancestor will be observed instead.
* This library uses `<iframe>`s to detect when an element resizes. `<iframe>`s are heavy objects are usually take good amount of memory. Be careful and don't abuse it.

## License

MIT

---
_Source: https://npm.io/package/simple-element-resize-detector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
