Esta página ha sido traducida del inglés por la comunidad.Aprende más y únete a la comunidad de MDN Web Docs.
MutationObserver
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since julio de 2015.
MutationObserver establece un mecanismo para reaccionar ante cambios en elDOM. Ha sido diseñado como un sustituto de losMutation Events definidos en las especificaciones deDOM3 Events.
In this article
Constructor
>MutationObserver()
Constructor para la instaciación de nuevosDOM mutation observers.
MutationObserver( function callback);
Parámetros
callbackLa función que será llamada en cada mutación del DOM. Elobserver llamará a esta función con dos argumentos. El primero es un array de objetos, cada uno del tipo
MutationRecord. El segundo es la propia instancia delMutationObserver.
Métodos
void observe( |
|---|
void disconnect(); |
Array takeRecords(); |
observe()
Registra la instancia delMutationObserver para recibir notificaciones de las mutaciones del DOM sobre el nodo especificado.
void observe(Node target, MutationObserverInit options);Parámetros
targetEl
Nodesobre el que observar las mutaciones del DOM.optionsUn objeto MutationObserverInit, que especifica que mutaciones del DOM deben ser informadas.
Nota:Añadir un observador a un elemento es igual que addEventListener, si usted observa el elemento múltiples veces no hace ninguna diferencia. Si se observa dos veces un elemento, el observe callback no se ejecutará dos veces, ni tampoco tendrá que ejecutar disconnect() dos veces. En otras palabras, una vez el elemento es observado, observarlo de nuevo con la misma instancia del observador no hará nada. Sin embargo, si el callback es diferente por supuesto se le añadirá otro observador.
disconnect()
Evita que la instanciade MutationObserver continue recibiendo notificaciones de modificaciones del DOM. Hasta que el métodoobserve() sea usado de nuevo, la función callback no será invocada.
void disconnect();
takeRecords()
Vacía la cola de registros de la instancia deMutationObserver devolviendo su contenido.
Array takeRecords();
Return value
Returns an Array ofMutationRecords.
MutationObserverInit
MutationObserverInit es un objeto para el que se pueden especificar las siguientes propiedades:
Nota:Como mínimo las propiedadeschildList,attributes, ocharacterData deben sertrue. En caso contrario, se producirá un error "An invalid or illegal string was specified"
| Propiedad | Descripción |
|---|---|
childList | Establecer atrue si la adición y/o eliminación de elementos hijo del nodo (incluso los nodostext) han se ser observados. |
attributes | Establecer atrue si los cambios en los atributos deben ser observados |
characterData | Establecer atrue si los cambios en los datos deben ser observados |
subtree | Establecer atrue si los cambios tambien deben ser observados en los descendientes. |
attributeOldValue | Establecer atrue siattributes estrue y el valor anterior al cambio debe ser guardado. |
characterDataOldValue | Establecer atrue sicharacterData valetrue y el dato anterior al cambio de be ser guardado. |
attributeFilter | Asigne un array de nombres de atributos locales (sin su espacio de nombres) si no necesita observar los cambios en todos los atributos |
MutationRecord
MutationRecord es el objeto que será pasado a la funcion "callback" del observador. Tiene las siguientes propiedades:
type:StringDevuelve:
attributessi el cambio fué en un atributocharacterDatasi se produjo en un nodo.childListsi se produjo en los nodos del árbol.
target:NodeDevuelve elnodo afectado por el cambio, dependiendo del
type:- Para
attributes, el elemento cuyos atributos han cambiado. - Para
characterData, el nodoCharacterData. - Para
childList, El nodo padre cuyos hijos han cambiado.
- Para
addedNodes:NodeListDevuelve los nodos añadidos. Si no tiene nodos añadidos devuelve un NodeList vacio.
removedNodes:NodeListDevuelve los nodos eliminados. Si no tiene nodos eliminados devuelve un NodeList vacio.
previousSibling:NodeDevuelve el nodo hermanoanterior añadido o eliminado, o el valor
null.nextSibling:NodeDevuelve elsiguiente nodo hermano añadido o eliminado, o el valor
null.attributeName:StringDevuelve el nombre local del atributo cambiado, o el valor
null.attributeNamespace:StringDevuelve espacio de nombres (namespace) del atributo cambiado, o el valor
null.oldValue:StringEl valor devuelto depende del
type:- Para
attributes,el valor anterior del atributo. - Para
characterData,los datos antes del cambio - Para
childList,devuelvenull.
- Para
Ejemplo de uso
El siguiente ejemplo fué tomado de:this blog post.
// selecciona el nodo targetvar target = document.querySelector("#some-id");// Crea una instancia de observervar observer = new MutationObserver(function (mutations) { mutations.forEach(function (mutation) { console.log(mutation.type); });});// Configura el observer:var config = { attributes: true, childList: true, characterData: true };// pasa al observer el nodo y la configuracionobserver.observe(target, config);// Posteriormente, puede detener la observacionobserver.disconnect();Especificaciones
| Specification |
|---|
| DOM> # interface-mutationobserver> |
Compatibilidad con navegadores
Lectura adicional
- A brief overview
- A more in-depth discussion
- A screencast by Chromium developer Rafael Weinstein
- The mutation summary library
- The DOM standard which defines the
MutationObserverinterface