CKTIS / JavaScript
MutationObserver — DOM-wijzigingen observeren
MutationObserver registreert geselecteerde DOM-wijzigingen en levert de records asynchroon aan een callbackfunctie. Lees hoe observe() de observatie instelt, takeRecords() de wachtrij leegt en disconnect() de observatie stopt.
Versie: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
const observer = new MutationObserver((records, observer) => { /* handle records */ });
observer.observe(target, options);
const pending = observer.takeRecords();
observer.disconnect();MutationObserver is een API uit de DOM-standaard en maakt niet zelf deel uit van ECMAScript. De callbackfunctie ontvangt een array met MutationRecord-objecten en de observer. De melding wordt als microtask in de wachtrij geplaatst en niet synchroon tijdens een wijziging afgeleverd; één aanroep kan meerdere records bevatten. Dat Node 24 in een repository aanwezig is, bewijst niet dat deze browser-API beschikbaar is.
MutationObserver.observe, aangeroepen als observer.observe(target, options), selecteert een knooppunt en mutatietypen: childList volgt toegevoegde en verwijderde kinderen, attributes volgt attributen en characterData volgt gegevens van tekstknooppunten en vergelijkbare knooppunten. subtree: true neemt afstammelingen mee. Na toepassing van de standaardwaarden moet minstens één type zijn ingeschakeld; anders wordt een TypeError gegenereerd. attributeFilter beperkt de attribuutnamen; attributeOldValue en characterDataOldValue vragen de vorige waarden op. Opties voor attributen of gegevens kunnen het bijbehorende observatietype impliciet inschakelen, maar expliciet tegenstrijdige instellingen veroorzaken een TypeError.
MutationObserver.takeRecords, aangeroepen als observer.takeRecords(), retourneert openstaande records synchroon en leegt de wachtrij zonder de callbackfunctie aan te roepen of de observatie te stoppen. MutationObserver.disconnect, aangeroepen als observer.disconnect(), stopt alle observaties van dit object en verwijdert openstaande records. Haal ze eerst op als je ze nodig hebt. Het object kan opnieuw worden gestart met observe().
Het voorbeeld observeert een losgekoppeld element, haalt het record op voordat de melding wordt afgeleverd en stopt de observatie. oldValue is null, omdat het attribuut eerder niet bestond. Houd de observatie beperkt; wijzigingen van de callbackfunctie kunnen nieuwe meldingen opleveren.
Voorbeelden
{
const target = document.createElement('div');
const observer = new MutationObserver((records) => {
console.log('callback:', records.length);
});
observer.observe(target, {
attributes: true,
attributeFilter: ['data-state'],
attributeOldValue: true
});
target.setAttribute('data-state', 'ready');
const records = observer.takeRecords();
console.log(JSON.stringify(records.map((record) => ({
type: record.type,
attributeName: record.attributeName,
oldValue: record.oldValue
}))));
observer.disconnect();
target.setAttribute('data-state', 'done');
console.log(observer.takeRecords().length);
}Resultaat
[{"type":"attributes","attributeName":"data-state","oldValue":null}]
0De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.