KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

MutationObserver: observe(), disconnect() en takeRecords()

Volg specifieke DOM-wijzigingen, haal openstaande records op zonder op de callback te wachten en kies bij het stoppen of je die records wilt bewaren.

Versie: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

const observer = new MutationObserver(callback);
observer.observe(target, options);
const records = observer.takeRecords();
observer.disconnect();

new MutationObserver(callback) maakt een observer aan, maar begint nog niet met observeren. observe(target, options), disconnect() en takeRecords() zijn instantiemethoden, geen statische methoden. Wijzigingen die aan de opties voldoen komen in een wachtrij. Een microtaak geeft ze als groep door aan callback(records, observer) in plaats van de callback bij elke wijziging synchroon aan te roepen.

observe(target, options) registreert een DOM-knooppunt (Node) en retourneert undefined. Met volgende aanroepen kun je andere doelen toevoegen of de opties voor hetzelfde doel wijzigen. childList volgt toevoegingen en verwijderingen van directe kindknopen, attributes volgt wijzigingen aan attributen, en characterData volgt wijzigingen aan knoopgegevens, zoals de inhoud van een tekstknoop. subtree: true past dezelfde regels toe op afstammelingen. Wijzigingen in een verwijderde tak kunnen vóór de volgende meldingsmicrotaak nog in de wachtrij komen.

attributeFilter beperkt welke attribuutnamen worden gevolgd. attributeOldValue: true en characterDataOldValue: true bewaren de vorige waarde in oldValue. Laat je attributes weg, dan schakelt het opgeven van attributeFilter of attributeOldValue attribuutobservatie in. Het opgeven van characterDataOldValue schakelt op dezelfde manier characterData in als dat ontbreekt. observe() gooit een TypeError als geen enkel wijzigingstype is ingeschakeld, als je attributes: false combineert met een filter of attributeOldValue: true, of als je characterData: false combineert met characterDataOldValue: true.

takeRecords() retourneert synchroon een array met openstaande MutationRecord-objecten ([] bij een lege wachtrij) en maakt de wachtrij leeg. De methode stopt de observatie niet en roept de callback niet aan: je verwerkt de records zelf. disconnect() retourneert undefined, stopt de observatie van alle doelen van die instantie en gooit niet-afgeleverde records weg. Wil je die bewaren, roep dan takeRecords() direct vóór disconnect() aan. Met observe() kun je dezelfde observer opnieuw gebruiken.

Dit is een DOM-API van het webplatform, geen onderdeel van ECMAScript 2024. De beschikbaarheid hangt af van de uitvoeringsomgeving. De observer geeft geen toegang tot knopen die anders ontoegankelijk zijn, zoals knopen in een iframe met een andere origin.

Voorbeelden

<!doctype html>
<meta charset="utf-8">
<title>MutationObserver example</title>
<script>
  const target = document.createElement('div');
  const options = { attributes: true, attributeFilter: ['data-state'] };
  const observer = new MutationObserver((records, currentObserver) => {
    console.log(`callback: ${records.length} ${records[0].attributeName}`);
    currentObserver.disconnect();
  });

  observer.observe(target, options);
  target.setAttribute('data-state', 'first');
  const [record] = observer.takeRecords();
  console.log(`taken: ${record.type} ${record.attributeName}`);

  target.setAttribute('data-state', 'discarded');
  observer.disconnect();
  target.setAttribute('data-state', 'unobserved');
  console.log(`remaining: ${observer.takeRecords().length}`);

  observer.observe(target, options);
  target.setAttribute('data-state', 'delivered');
</script>

Resultaat

taken: attributes data-state
remaining: 0
callback: 1 data-state

Sla het volledige voorbeeld op als HTML-bestand, open het in een browser en bekijk de uitvoer in de ontwikkelaarsconsole. Het element wordt niet aan de pagina toegevoegd. `takeRecords()` haalt het eerste record op, `disconnect()` gooit het tweede weg en de wijziging tijdens de onderbreking wordt niet vastgelegd. Alleen de wijziging na het hervatten bereikt de callback.

Gerelateerde lessen

  • JavaScript · Les 31 · Gemiddeld · Versie: 3

Bronnen