CKTIS / JavaScript
MutationRecord: come leggere una modifica del DOM
Individua il tipo di modifica e il nodo interessato, esamina i figli aggiunti o rimossi e verifica quando il record contiene il valore precedente.
Versione: ECMAScript 2024 and the current web platform; runtime support varies
Sintassi
const { type, target, addedNodes, removedNodes, attributeName, oldValue } = record;Un MutationRecord descrive una singola modifica del DOM. Un MutationObserver passa i record alla funzione di callback in un microtask, non durante la modifica stessa. Queste proprietà sono di sola lettura. Parti da type per interpretare gli altri campi. È un’API della piattaforma web, non di ECMAScript 2024: non darla per disponibile in un ambiente senza DOM.
Per type === "childList", target è il nodo i cui figli diretti sono cambiati. addedNodes e removedNodes sono oggetti NodeList che contengono rispettivamente i figli aggiunti e rimossi da quella modifica. Se non è stato aggiunto o rimosso alcun figlio, la lista corrispondente è vuota, non null. Lo spostamento di un nodo può produrre record distinti per la rimozione e l’aggiunta.
Per type === "attributes", target è l’elemento modificato. attributeName contiene il nome locale dell’attributo, senza il prefisso dello spazio dei nomi. oldValue contiene il valore precedente dell’attributo come stringa se in observe() è impostato attributeOldValue: true. Altrimenti vale null, come quando l’attributo non esisteva prima.
Per type === "characterData", target è il nodo CharacterData stesso, per esempio un nodo di testo, non il suo genitore. oldValue contiene i dati precedenti come stringa solo con characterDataOldValue: true; altrimenti vale null. Per "childList", oldValue è sempre null. Al di fuori del caso "attributes", attributeName vale null; al di fuori di "childList", entrambe le liste di nodi sono vuote.
Con subtree: true, il target del record può essere un discendente del nodo passato a observe(). Non esiste un campo newValue: leggere i dati da target restituisce lo stato corrente, che può già riflettere modifiche successive.
Esempi
<!doctype html>
<meta charset="utf-8">
<title>MutationRecord example</title>
<script>
(() => {
const root = document.createElement("div");
const text = document.createTextNode("hello");
const child = document.createElement("span");
root.setAttribute("data-state", "before");
root.append(text);
const observer = new MutationObserver(() => {});
observer.observe(root, {
attributes: true,
attributeOldValue: true,
characterData: true,
characterDataOldValue: true,
childList: true,
subtree: true,
});
root.setAttribute("data-state", "after");
text.data = "world";
root.append(child);
child.remove();
const records = observer.takeRecords();
observer.disconnect();
const nodeNames = (nodes) => Array.from(nodes, (node) => node.nodeName);
for (const { type, target, addedNodes, removedNodes, attributeName, oldValue } of records) {
console.log(JSON.stringify([
type, target.nodeName, nodeNames(addedNodes), nodeNames(removedNodes),
attributeName, oldValue,
]));
}
})();
</script>Risultato
["attributes","DIV",[],[],"data-state","before"] ["characterData","#text",[],[],null,"hello"] ["childList","DIV",["SPAN"],[],null,null] ["childList","DIV",[],["SPAN"],null,null]
Salva l’esempio completo come file HTML, aprilo in un browser e controlla l’output nella console. `takeRecords()` recupera i record e svuota la coda prima della chiamata alla funzione di callback, quindi il codice stampa quattro record in ordine. Il record di aggiunta include ancora `SPAN`, anche se il nodo è stato rimosso in seguito.
Lezioni correlate
- JavaScript · Lezione 31 · Intermedio · Versione: 3
Fonti
- MutationRecord
- MutationRecord: target property
- MutationRecord: addedNodes property
- MutationRecord: removedNodes property
- MutationRecord: attributeName property
- MutationRecord: oldValue property
- MutationObserver: observe() method
- MutationObserver: takeRecords() method
- Using microtasks in JavaScript with queueMicrotask()