CKTIS / JavaScript
MutationRecord: een DOM-wijziging uitlezen
Bepaal het soort wijziging en de betrokken knoop, bekijk toegevoegde of verwijderde kinderen en lees wanneer het record de vorige waarde bevat.
Versie: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
const { type, target, addedNodes, removedNodes, attributeName, oldValue } = record;Een MutationRecord beschrijft één DOM-wijziging. Een MutationObserver geeft de records in een microtaak door aan zijn callback, niet tijdens de wijziging zelf. Deze eigenschappen zijn alleen-lezen. Lees eerst type om de andere velden te interpreteren. Deze API hoort bij het webplatform, niet bij ECMAScript 2024. Ga er niet van uit dat de API beschikbaar is in een omgeving zonder DOM.
Bij type === "childList" is target de knoop waarvan de directe kinderen zijn gewijzigd. addedNodes en removedNodes zijn NodeList-objecten met respectievelijk de kinderen die door die wijziging zijn toegevoegd en verwijderd. Als er niets is toegevoegd of verwijderd, is de betreffende lijst leeg, niet null. Bij het verplaatsen van een knoop kunnen aparte records voor verwijdering en toevoeging ontstaan.
Bij type === "attributes" is target het gewijzigde element. attributeName bevat de lokale naam van het attribuut, zonder naamruimteprefix. oldValue bevat de vorige attribuutwaarde als tekenreeks als observe() is aangeroepen met attributeOldValue: true. Anders is de waarde null, net als wanneer het attribuut voordien niet bestond.
Bij type === "characterData" is target de CharacterData-knoop zelf, bijvoorbeeld een tekstknoop, niet de bovenliggende knoop. oldValue bevat de vorige gegevens alleen met characterDataOldValue: true als tekenreeks; anders is het null. Bij "childList" is oldValue altijd null. Buiten het geval "attributes" is attributeName gelijk aan null, en buiten het geval "childList" zijn beide knooplijsten leeg.
Met subtree: true kan de target van het record een afstammeling zijn van de knoop die aan observe() is doorgegeven. Er is geen veld newValue: bij het uitlezen van target krijg je de huidige toestand, waarin latere wijzigingen al verwerkt kunnen zijn.
Voorbeelden
<!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>Resultaat
["attributes","DIV",[],[],"data-state","before"] ["characterData","#text",[],[],null,"hello"] ["childList","DIV",["SPAN"],[],null,null] ["childList","DIV",[],["SPAN"],null,null]
Sla het volledige voorbeeld op als HTML-bestand, open het in een browser en bekijk de uitvoer in de console. `takeRecords()` haalt de records op en maakt de wachtrij leeg voordat de callback wordt aangeroepen. De code schrijft daardoor vier records achter elkaar naar de console. Het record voor de toevoeging vermeldt nog steeds `SPAN`, ook al is de knoop later verwijderd.
Gerelateerde lessen
- JavaScript · Les 31 · Gemiddeld · Versie: 3
Bronnen
- 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()