@juggle/resize-observer - npm Package Compare versions

Comparing version 0.7.1 to 0.7.2

package.json

		{
		"name": "@juggle/resize-observer",
		"version": "0.7.1",
		"version": "0.7.2",
		"description": "ResizeObserver - Based on the official draft specification",
		@@ -5,0 +5,0 @@ "main": "./lib/ResizeObserver.js",

README.md

		@@ -1,15 +0,15 @@
		# ResizeObserver
		<h1>
		Resize Observer Polyfill
		<br/><br/>
		<img src="https://img.shields.io/circleci/project/github/juggle/resize-observer/master.svg?logo=circleci&style=for-the-badge"/>
		<img src="https://img.shields.io/coveralls/github/juggle/resize-observer.svg?logoColor=white&style=for-the-badge"/>
		<img src="https://img.shields.io/bundlephobia/minzip/@juggle/resize-observer.svg?colorB=%233399ff&style=for-the-badge"/>
		<img src="https://img.shields.io/npm/l/@juggle/resize-observer.svg?colorB=%233399ff&style=for-the-badge"/>
		</h1>

		![](https://img.shields.io/circleci/project/github/juggle/resize-observer/master.svg?logo=circleci&style=for-the-badge)
		![](https://img.shields.io/coveralls/github/juggle/resize-observer.svg?logoColor=white&style=for-the-badge)
		![](https://img.shields.io/bundlephobia/minzip/@juggle/resize-observer.svg?colorB=%233399ff&style=for-the-badge)
		![](https://img.shields.io/npm/l/@juggle/resize-observer.svg?colorB=%233399ff&style=for-the-badge)
		A minimal library which polyfills the ResizeObserver API and is entirely based on the latest [Draft Specification](https://drafts.csswg.org/resize-observer-1/). Essentially, it detects when an element's size changes, allowing you to deal with it!

		A minimal library which polyfills the ResizeObserver API and is entirely based on the latest [Draft Specification](https://drafts.csswg.org/resize-observer-1/).
		Check out the [Demo Playground](https://codesandbox.io/embed/myqzvpmmy9?hidenavigation=1&module=%2Fsrc%2Findex.js&view=preview)

		This library observes elements and dispatches notifications when their dimensions change. Differences are only calculated during animation, or, after DOM mutation or user interaction has occurred, keeping CPU and power consumption minimal.

		[Demo Playground](https://codesandbox.io/embed/myqzvpmmy9?hidenavigation=1&module=%2Fsrc%2Findex.js&view=preview)


		## Installation
		@@ -31,3 +31,3 @@ ``` shell
		```
		This will use the ponyfilled version of ResizeObserver, even if the browser supports ResizeObserver natively.
		This will use the [ponyfilled](https://github.com/sindresorhus/ponyfill) version of ResizeObserver, even if the browser supports ResizeObserver natively.

		@@ -52,3 +52,5 @@ ## Watching multiple elements

		The latest standards allow for watching different box sizes. The box size option can be specified when observing an element. Options inlcude `border-box` `content-box` `scroll-box` `device-pixel-border-box`. `device-pixel-border-box` can only be used on a `canvas` element.
		The latest standards allow for watching different box sizes. The box size option can be specified when observing an element. Options inlcude `border-box`, `content-box`, `scroll-box`, `device-pixel-border-box`.

		`device-pixel-border-box` can only be used on `canvas` elements.
		``` js
		@@ -89,6 +91,44 @@ import ResizeObserver from '@juggle/resize-observer';

		> Warning: Browsers with native support may be behind on the latest specification.


		## Resize loop detection

		Resize Observers have inbuilt protection against infinite resize loops.

		If an element's observed box size changes again within the same resize loop, the observation will be skipped and an error event will be dispatched on the window.

		```js
		import ResizeObserver from '@juggle/resize-observer';

		const ro = new ResizeObserver((entries, observer) => {
		// Changing the body size inside of the observer
		// will cause a resize loop and the next observation will be skipped
		document.body.style.width = '50%';
		});

		// Listen for errors
		window.addEventListener('error', e => console.log(e.message));

		// Observe the body
		ro.observe(document.body);
		```


		## How are differences detected?

		To prevent constant polling, every frame. The DOM is queried whenever an event occurs which could cause an element to change its size. This could be when an element is clicked, a DOM Node is added, or, when an animation is running.

		To cover these scenarios, there are two types of observation. The first is to listen to specific DOM events, including `resize`, `mousedown` and `focus` to name a few. The second is to listen for any DOM mutations that occur. This detects when a DOM node is added or removed, an attribute is modified, or, even when some text has changed.

		This allows for greater idle time, when the application itself is idle.


		## What's it good for?
		- Building responsive websites.

		- Building responsive applications.
		- Creating 'self-aware' Web Components.
		- Making 3rd party libraries more responsive. e.g. charts and grids.
		- Locking scroll position to the bottom of elements - useful for chat windows and logs.
		- Canvas rendering (including HDPI).
		- Many other things!
		@@ -100,4 +140,3 @@
		- No support for IE10 and below. IE11 is supported.
		- Dynamic stylesheet changes may not be noticed and updates will occur on the next user interaction.
		- Currently no support for observations when `display:none` is toggled (coming soon).
		- Dynamic stylesheet changes may not be noticed and updates will occur on the next interaction.

		@@ -104,0 +143,0 @@

@juggle/resize-observer - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics