mutationobserver-shim

What is mutationobserver-shim?

The mutationobserver-shim package is a polyfill for the MutationObserver API, which allows you to watch for changes being made to the DOM tree. This is particularly useful for environments where the native MutationObserver is not available.

What are mutationobserver-shim's main functionalities?

Observing attribute changes

This feature allows you to observe changes to attributes of a DOM element. The provided code sample sets up a MutationObserver to watch for attribute changes on an element with the ID 'some-id'.

const targetNode = document.getElementById('some-id');
const config = { attributes: true };
const callback = function(mutationsList, observer) {
  for(let mutation of mutationsList) {
    if (mutation.type === 'attributes') {
      console.log('The ' + mutation.attributeName + ' attribute was modified.');
    }
  }
};
const observer = new MutationObserver(callback);
observer.observe(targetNode, config);

Observing child list changes

This feature allows you to observe changes to the child nodes of a DOM element. The provided code sample sets up a MutationObserver to watch for additions or removals of child nodes on an element with the ID 'some-id'.

const targetNode = document.getElementById('some-id');
const config = { childList: true };
const callback = function(mutationsList, observer) {
  for(let mutation of mutationsList) {
    if (mutation.type === 'childList') {
      console.log('A child node has been added or removed.');
    }
  }
};
const observer = new MutationObserver(callback);
observer.observe(targetNode, config);

Observing subtree changes

This feature allows you to observe changes to the entire subtree of a DOM element. The provided code sample sets up a MutationObserver to watch for additions or removals of child nodes within the subtree of an element with the ID 'some-id'.

const targetNode = document.getElementById('some-id');
const config = { subtree: true, childList: true };
const callback = function(mutationsList, observer) {
  for(let mutation of mutationsList) {
    if (mutation.type === 'childList') {
      console.log('A child node has been added or removed in the subtree.');
    }
  }
};
const observer = new MutationObserver(callback);
observer.observe(targetNode, config);

Other packages similar to mutationobserver-shim

mutation-observer

The mutation-observer package is another polyfill for the MutationObserver API. It provides similar functionality to mutationobserver-shim, allowing you to observe changes to the DOM tree. Both packages aim to provide a consistent API for environments where the native MutationObserver is not available.

mutation-summary

The mutation-summary package provides a higher-level API for observing changes to the DOM. It allows you to specify queries to observe and provides summaries of the changes. This package offers more advanced features compared to mutationobserver-shim, but it may be more complex to use.

README

MutationObserver

^{Note: IE7 fails due to quirky attribute handling (see #4)
Safari 6.0.5 uses a buggy WebKitMutationObserver (don't have a computer with Safari to test on unfortuantely)}

A polyfill for the MutationObserver API (can I use?). The polyfill is more cause we can than should (with subtree at any rate)... It's async and uses a recursive timeout fallback (default checks changes every 30ms + runtime) instead of using the deprecated DOM3 MutationEvents so theoretically can support virtually any browser.

$ npm install mutationobser-shim
$ bower install MutationObserver-shim

Polyfill differences from standard interface

MutationObserver

• Implemented using a recursive setTimeout (every ~30 ms) rather than using a setImmediate polyfill; so calls will be made less frequently and likely with more data than the standard MutationObserver. In addition, it can miss changes that occur and then are lost in the interval window.
• Setting an observed elements html using innerHTML will call childList observer listeners with several mutations with only 1 addedNode or removed node per mutation. With the standard you would have 1 call with multiple nodes in addedNodes and removedNodes node lists.
• With childList and subtree changes in node order (eg first element gets swapped with last) should fire a addedNode and removedNode mutation but the correct node may not always be identified.

MutationRecord

• addedNodes and removedNodes are arrays instead of NodeLists
• oldValue is always called with attribute changes
• nextSibling and previousSibling correctfullness is questionable (hard to know if the order of appended items). I'd suggest not relying on them anyway (my tests are extremely permissive with these attributes)

Supported MutationObserverInit properties

Currently supports the following MutationObserverInit properties:

• childList: Set to truthy if mutations to target's immediate children are to be observed.
• subtree: Set to truthy to do deep scans on a target's children.
• attributes: Set to truthy if mutations to target's children are to be observed. As explained in #4, the style attribute may not be matched in ie<8.
• attributeFilter: Set to an array of attribute local names (without namespace) if not all attribute mutations need to be observed.
• attributeOldValue: doesn't do anything attributes are always called with old value
• characterData: currently follows Mozilla's implementation in that it will only watch textNodes values and not, like in webkit, where setting .innerHTML will add a characterData mutation.

Performance

By default, the polyfill will check observed nodes about 25 times per second (30 ms interval) for mutations. Try running these jsperf.com tests and the JSLitmus tests in the test suite for usage performance tests. It may be worthwile to adapt MutaitonObserver._period based on UA or heuristics (todo).

From my tests observing any size element without subtree enabled is relatively cheap. Although I've optimized the subtree check to the best of my abilities it can be costly on large trees. You can draw your own conclusions based on the JSLitmus and jsperf tests noting that you can expect the mo to do its check 28+ times a second (by default).

Although supported, I'd recommend against watching attributes on the subtree on large structures, as the check is complex and expensive on terrible hardware like my phone :(

The included minified file has been tuned for performance.

Compatibility

I've tested and verified compatibility in the following browsers + these Sauce browsers

• Internet Explorer 8 (emulated), 9, 10 in win7 and win8
• Firefox 4, 21, 24, 26 in OSX, win7 and win8
• Opera 11.8, 12.16 in win7
• "Internet" on Android HTC One V
• Blackberry 6.0.16

Try running the test suite and see some simple example usage:

• http://jsbin.com/uxAQEWuL/3 listen to images being appended dynamically
• http://jsbin.com/uxAQEWuL/5 autoscroll an element as new content is added

See http://dev.opera.com/articles/view/mutation-observers-tutorial/ for some sample usage.