kapetan/jquery-observe

Observe DOM mutations with jQuery

jQuery Observe

A jQuery plugin which simplifies the use of the new DOM Mutation Observer interface introduced in newer browsers. jquery-observe.js contains the compiled and minified version of the plugin.

Available through bower

bower install jquery-observe

And npm

npm install @kapetan/jquery-observer

Compatibility

At this point the Mutation Observer API is only available in newer versions of Google Chrome (>= 18) and Mozilla Firefox (>= 14). Can be useful when developing extensions (add-ons) that use content scripts, on a page that you don't control.

There is a fallback for browsers who don't support the Mutation Observer API (mainly IE9 and Opera), using the deprecated DOM Mutation Events interface. These don't act completely as Mutation Observers, and can cause some different behaviour between browsers. For instance an event is fired for every descendant of an inserted node, where only one record is dispatched when using Mutation Observers. Furthermore because mutation events don't have the same information associated with them as Mutation Observer records, some contextual selectors may not match removed nodes. Some of those are :first, :first-child, :eq, :last, :last-child, :even and :odd (not an exhaustive list).

Usage

The observe interface $.fn.observe() is somewhat similar to the jQuery event api using the $.fn.on() method.

$('#content')
	.observe('attributes', function(record) {
		// Observe attribute changes on #content
	})
	.observe('childlist subtree', function(record) {
		// Observe changes in the subtree
	})
	.observe({ attributes: true, attributeFilter: ['class'] }, function(record) {
		// Observe changes in attribute class on #content
	});

The callback function gets passed the MutationRecord instance matching the query.

The first argument can either be a string or an object containing the options which are passed to MutaionObserver.observe() method. See the w3c documentation for Mutation Observer for more information on the available options.

All the above observers are collapsed into a single Mutation Observer object using #content as target.

The real power comes when using a selector to filter the elements.

$('#content')
	.observe('childlist', 'ul li:first', function(record) {
		// Observe if elements matching '#content ul li:first' have been added or removed
	})
	.observe('attributes', '.section p:visible', function(record) {
		// Observe if elements matching '#content .section p:visible' have been added or removed
	})

In the above callback functions this refers to the available matched DOM element. In the case where no selector is given this always refers to the element which .observe() was called on. When a selector is present this references different elements.

• Records of type attributes: this refers to the node which had an attribute changed.

• Records of type characterData: this refers to the parent element of the text node which had its content modified. The modified text node can be retrieved trough record.target.

• Records of type childList and the selector matches an added node: this refers to the added node.

• Records of type childList and the selector matches a removed node: this refers to the parent of the removed node (since the removed node is no longer available in the DOM).

This also means that the callback is called for every matched element (similar to $.fn.on()).

Using the above defined observers with the following HTML:

	<div id='content'>
		<ul>
			<li><span></span></li>
		</ul>
		<span class='section'><p class='hello'>Hello</p></span>
	</div>

• Running $('#content ul').append('<li></li>') // added as last element will not trigger the first observer neither will $('#content ul li:first').append('<span></span>'), since the observe selector only matches nodes that either have been added or removed.

• Running $('#content ul').prepend('<li></li>') will trigger the first observer, since a li element was inserted as the first child. And this will reference to the newly inserted node.

• Running $('#content ul li:first').remove() also triggers the first observer. In this case this will reference to the parent of the removed element (the ul element).

• Running $('#content ul li:first span').remove() will not trigger the first observer.

• Running $('#content span p').addClass('myClass') triggers the second observer.

Note that the changes to the DOM don't have to be performed using jQuery. The last example can also be run using plain javascript document.getElementsByClassName('hello')[0].className += ' myClass'.

Extended options

There are two custom Mutation Observer options which can be used together with the other options. These are added and removed. Which only trigger an observer if either a node has been added or removed.

	$('#content')
		.observe('added', 'li:first', function(record) {
			// Only called if a node matching '#content li:first' has been added
		})
		.observe('removed', 'li:first', function(record) {
			// Only called if a node matching '#content li:first' has been removed
		});

Using the options 'added removed' is equivalent to 'childlist'.

Removing observers

Use the $.fn.disconnect() method to remove an observer. The arguments must match the arguments given to the $.fn.observe() method. Or call the disconnect method without arguments to remove all observers. The underlying Mutation Observer is disabled when there are no observers listening for changes.

Issues

There are some problems getting the characterData option to work in Chrome (may be because of bug #134322).

License

This software is licensed under "MIT"

Copyright (c) 2012 Mirza Kapetanovic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

jquery-observe's Issues

observe is incorrectly dealing with text node additions

Take this example: http://jsfiddle.net/7Vffy/

function message(msg) {
    // This gets called twice!
    $('#message').append("<div>" + msg + "</div>");
}

$(function() {
    $('body').observe('added', '.foo', function() {
        message("Added element: " + this.tagName + "." + this.className);
    });

    $('#container').append('<div class="foo"></div>');
    $('body').append('hi there');
});

The culprit appears to be this line:

element = $(mapTextNodes(element));

so when a text node is added to <body>, it behaves as though the <body> were just added to the DOM.

What case is mapTextNodes() meant to handle?

library breaks on older browsers because it depends on Function.prototype.bind()

Consider using the polyfill: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind#Compatibility

Some mutations are not picked up on

When u mutate DOM from this page for example https://steamlvlup.com/, by e.g. sorting or loading new page, the observer doesn't report it.

Unminified Version

Hey, great work. An unminified version of your dist would be appreciated. Best regards, bm2u

Preventing multiple mutation callbacks to fire

I have a question to your plugin. I think that's not a bug and it's only related to my code.
But I'm not sure how to fix it.

Please have a look at this fiddle.

I'm using it like in this snippet $(document).observe('added', 'a[href^="file://"]', function(record) {...} to observe additions to the DOM.

The fiddle is working like I want it but I need to check that the addedNodes are new nodes because I'm getting multiple callbacks for one DOM addition. The check is done by storing the lastAdded nodes in a variable. Here's the callback code (fileLinkSelectors is an array with start-with selectors, see fiddle):

$(document)
  .observe('added', fileLinkSelectors.join(', '), function(record) {
    if (latestNodesAdded !== record.addedNodes) {
        // new nodes
        updateLink(record.addedNodes); // adds an icon to a link
        latestNodesAdded = record.addedNodes; // save addedNodes --> only needed because of multiple mutationObserver callbacks
    } else {
        console.log('I\'d like to avoid this callback');
    }
});

Is it possible to watch every new link added to DOM with-out getting multiple callbacks? (It could be a performance issue if there are added thousands of links with ajax.)

I think disconnecting the observer is not working becasue I can't resume the observer later.

Use Without Installing?

hi, when you say to install with bower, do you mean for backend node.js?

i'm writing front-end jquery. Can i simply point to your script file, instead of installing? (hosted on my own server)

thx