The MutationObserver
method observe()
configures the MutationObserver
callback to begin receiving notifications of changes to the DOM that match the given options. Depending on the configuration, the observer may watch a single Node
in the DOM tree, or that node and some or all of its descendant nodes.
To stop the MutationObserver
(so that none of its callbacks will be triggered any longer), call MutationObserver.disconnect()
.
Syntax
mutationObserver.observe(target, options)
Parameters
target
- A DOM
Node
(which may be anElement
) within the DOM tree to watch for changes, or to be the root of a subtree of nodes to be watched. options
- A
MutationObserverInit
object providing options that describe which DOM mutations should be reported tomutationObserver
’scallback
.
Return value
undefined
.
Exceptions
TypeError
- Thrown in any of the following circumstances:
- The
options
are configured such that nothing will actually be monitored.
(For example, ifMutationObserverInit.childList
,MutationObserverInit.attributes
, andMutationObserverInit.characterData
are allfalse
.) - The value of
options.attributes
isfalse
(indicating that attribute changes are not to be monitored), butattributeOldValue
istrue
and/orattributeFilter
is present. - The
characterDataOldValue
option istrue
butMutationObserverInit.characterData
isfalse
(indicating that character changes are not to be monitored).
- The
Usage notes
Reusing MutationObservers
You can call observe()
multiple times on the same MutationObserver
to watch for changes to different parts of the DOM tree and/or different types of changes. There are some caveats to note:
- If you call
observe()
on a node that's already being observed by the sameMutationObserver
, all existing observers are automatically removed from all targets being observed before the new observer is activated. - If the same
MutationObserver
is not already in use on the target, then the existing observers are left alone and the new one is added.
Observation follows nodes when disconnected
Mutation observers are intended to let you be able to watch the desired set of nodes over time, even if the direct connections between those nodes are severed. If you begin watching a subtree of nodes, and a portion of that subtree is detached and moved elsewhere in the DOM, you continue to watch the detached segment of nodes, receiving the same callbacks as before the nodes were detached from the original subtree.
In other words, until you've been notified that nodes are being split off from your monitored subtree, you'll get notifications of changes to that split-off subtree and its nodes. This prevents you from missing changes that occur after the connection is severed and before you have a chance to specifically begin monitoring the moved node or subtree for changes.
Theoretically, this means that if you keep track of the MutationRecord
objects describing the changes that occur, you should be able to "undo" the changes, rewinding the DOM back to its initial state.
Example
In this example, we demonstrate how to call the method observe()
on an instance of MutationObserver
, once it has been set up, passing it a target element and a MutationObserverInit
options object.
// identify an element to observe const elementToObserve = document.querySelector("#targetElementId"); // create a new instance of `MutationObserver` named `observer`, // passing it a callback function const observer = new MutationObserver(function() { console.log('callback that runs when observer is triggered'); }); // call `observe()` on that MutationObserver instance, // passing it the element to observe, and the options object observer.observe(elementToObserve, {subtree: true, childList: true});
Specifications
Specification | Status | Comment |
---|---|---|
DOM The definition of 'MutationObserver.observe()' in that specification. |
Living Standard |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
observe | Chrome Full support 18 | Edge Full support 12 | Firefox Full support 14 | IE Full support 11 | Opera Full support 15 | Safari Full support 6 | WebView Android Full support ≤37 | Chrome Android Full support 18 | Firefox Android Full support 14 | Opera Android Full support 14 | Safari iOS Full support 6 | Samsung Internet Android Full support 1.0 |
Legend
- Full support
- Full support