resize-observer-polyfill

What is resize-observer-polyfill?

The resize-observer-polyfill package provides a polyfill for the ResizeObserver API, which allows you to be notified when an element's content rectangle has changed its size, and thus react accordingly. This is particularly useful for responsive designs and element-specific layout updates.

What are resize-observer-polyfill's main functionalities?

Observing element size changes

This feature allows you to observe changes in the size of an element. The callback function is executed whenever the size of the observed element changes, providing you with the new dimensions and allowing you to perform any necessary adjustments.

var ro = new ResizeObserver(entries => {
  for (let entry of entries) {
    const cr = entry.contentRect;
    console.log('Element:', entry.target);
    console.log(`Element size: ${cr.width}px x ${cr.height}px`);
    console.log(`Element padding: ${cr.top}px ; ${cr.left}px`);
  }
});

ro.observe(document.getElementById('myElement'));

Other packages similar to resize-observer-polyfill

element-resize-detector

element-resize-detector is an npm package that offers a way to detect when an element has been resized. It differs from resize-observer-polyfill in that it uses scroll events and other tricks to detect size changes instead of the native ResizeObserver API, which can be useful for broader browser support.

css-element-queries

css-element-queries provides a way to attach event listeners to elements for various purposes, including element resize detection. It includes a ResizeSensor class that can be used to detect when an element's size changes. This package offers additional functionalities like element query conditions, which go beyond the scope of resize-observer-polyfill.

README

ResizeObserver Polyfill

A polyfill for the Resize Observer API.

Implementation is based on the MutationObserver and uses Mutation Events as a fall back if the first one is not supported, so there will be no polling unless DOM changes. Doesn't modify observed elements. Handles CSS transitions/animations, <textarea> resizes and can possibly observe changes caused by dynamic CSS pseudo-classes, e.g. by :hover.

Follows the spec and the native implementation. The size is 2.44 KiB when minified and gzipped.

Live demo (has style problems in IE10 and lower).

Installation

From NPM:

npm install resize-observer-polyfill --save-dev

From Bower:

bower install resize-observer-polyfill --save-dev

Or just grab the pre-built version.

Browser Support

Polyfill has been tested in the following browsers:

NOTE: Internet Explorer 8 and its earlier versions are not supported.

Usage Example

It's recommended to use this library in the form of a ponyfill, which doesn't inflict modifications of the global object.

import ResizeObserver from 'resize-observer-polyfill';

const ro = new ResizeObserver((entries, observer) => {
    for (const entry of entries) {
        const {left, top, width, height} = entry.contentRect;

        console.log('Element:', entry.target);
        console.log(`Element's size: ${ width }px x ${ height }px`);
        console.log(`Element's paddings: ${ top }px ; ${ left }px`);
    }
});

ro.observe(document.body);

Package's main file is a ES5 UMD bundle that will be swapped with the ES6 modules version for those bundlers that are aware of the jnext:main field, e.g. for Rollup or webpack.

Note: global version of the polyfill (dist/ResizeObserver.global) is deprecated and will be removed in the next major release.

Observation Strategy

As mentioned above, this implementation primarily (but not solely) relies on Mutation Observer with a fallback to Mutation Events for IE 9, IE 10 and IE 11. It's important to notice that even though MO is available in Internet Explorer 11, it won't be used due to a very unreliable behavior mentioned in the issue #6 (run this example in IE11).

Speaking of Mutation Events as a fallback approach: they might not be as ugly as they are being rendered, particularly when their calls are batched, throttled and there is no need to analyze changes. Given that, they won't interrupt browser's reflow/repaint cycles (same for MutationObserver) and may even outperform Internet Explorer's implementation of MO causing little to no performance degradation. In contemporary browsers (Chrome, Firefox, etc.) Mutation Observer slows down the suite that includes 200 iterations of adding/removing elements, changing attributes and modifying text data by less than 1%. Internet Explorer gives different results with MO slowing down the same suite by 2-3% while Mutation Events show the difference of ~0.6%.

As for the reasons why other approaches, namely the iframe/object and scroll strategies, were ruled out:

• They require the observed element to be non-statically positioned.
• You can't apply them directly to quite a number of elements: <img>, <input>, <textarea>, <canvas>, <tr>, <tbody>, <thead>, <table>, etc. For most of them you would need to keep an extra <div> wrapper and almost all instances of the SVGGraphicsElement will be out of scope.
• The ResizeObserver spec requires to deliver notifications when a non-empty visible element becomes hidden, i.e. when either this element directly or one of its parent nodes receive the display: none state. Same goes for when it's being removed from or added to the DOM. It's not possible to handle these cases merely by using former approaches, so you'd still need to either subscribe for DOM mutations or to continuously check the element's state.

And though every approach has its own limitations, I reckon that it'd be too much of a trade-off to have those constraints when building a polyfill.

Limitations

• Notifications are delivered ~20ms after actual changes happen.
• Changes caused by dynamic pseudo-classes, e.g. :hover and :focus, are not tracked. As a workaround you could add a short transition which would trigger the transitionend event when an element receives one of the former classes (example).
• Delayed transitions will receive only one notification with the latest dimensions of an element.

Building and Testing

To build polyfill. Creates UMD bundle in the dist folder:

npm run build

To run a code style test:

npm run test:lint

Running unit tests:

npm run test:spec

To test in a browser that is not present in karma's config file:

npm run test:spec:custom

Testing against a native implementation:

npm run test:spec:native

NOTE: after you invoke spec:native and spec:custom commands head to the http://localhost:9876/debug.html page.