KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

Opties voor MutationObserver: wijzigingstypen, subboom, filter en oude waarden

Stel met `observe()` in of je wijzigingen aan kindknopen, attributen of tekengegevens volgt, hoe ver de observatie reikt en wanneer een record de vorige waarde bevat.

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

Syntax

const observer = new MutationObserver((records, observer) => {
  for (const record of records) {
    // Read record.type, record.target, or record.oldValue.
  }
});

observer.observe(target, {
  childList: true,
  attributes: true,
  characterData: true,
  subtree: true,
  attributeFilter: ["data-state"],
  attributeOldValue: true,
  characterDataOldValue: true,
});

new MutationObserver(callback) maakt een observer aan; observer.observe(target, options) start het volgen van een DOM-knoop. De callback krijgt een array met MutationRecord-objecten en de observer. Dit is een DOM-API van het webplatform, geen onderdeel van ECMAScript 2024; de beschikbaarheid hangt af van de uitvoeringsomgeving.

childList meldt dat directe kindknopen van een gevolgde knoop zijn toegevoegd of verwijderd (addedNodes, removedNodes). attributes meldt toegevoegde, gewijzigde en verwijderde attributen van elementen. characterData meldt wijzigingen aan een bestaande CharacterData-knoop, bijvoorbeeld aan text.data. Een waarde toewijzen aan textContent van een element vervangt zijn kindknopen. Een wijziging in die lijst wordt gemeld als childList, niet als characterData. subtree: true breidt de gekozen wijzigingstypen uit naar afstammelingen; standaard wordt alleen target gevolgd.

attributeFilter bevat lokale attribuutnamen, geen CSS-selectors. Met een filter tellen alleen genoemde attributen zonder naamruimte mee; zonder filter komen alle attributen in aanmerking. attributeOldValue: true en characterDataOldValue: true bewaren de waarde van vóór de betreffende wijziging in de alleen-lezen eigenschap record.oldValue. Er is geen optie oldValue en geen veld newValue. oldValue is null bij childList, als de oude waarde niet is opgevraagd of als het attribuut voordien niet bestond.

childList is standaard false. Laat je attributes weg, dan wordt het true als je attributeFilter of attributeOldValue opgeeft. Laat je characterData weg, dan wordt het true als je characterDataOldValue opgeeft. Bij de opties voor oude waarden telt alleen al de aanwezigheid, ook met false. Anders staan beide typen standaard uit. observe() gooit een TypeError als geen wijzigingstype aanstaat, bij attributes: false met een filter of attributeOldValue: true, of bij characterData: false met characterDataOldValue: true.

De callback ontvangt de records gebundeld in een microtaak, niet tijdens de DOM-wijziging zelf. Met subtree: true kan de subboom van een verwijderde afstammeling dankzij tijdelijke registraties nog worden gevolgd. De microtaak voor meldingen verwijdert die registraties bij het verwerken van de observer, voordat die eventueel de callback aanroept. Daarvoor hoeft geen verwijderingsrecord te worden afgeleverd: childList kan uitstaan of takeRecords() kan de wachtrij al hebben geleegd. disconnect() stopt de observatie en gooit wachtende records weg. Wil je die behouden, haal ze dan eerst op met takeRecords(), dat de wachtrij leegt.

Voorbeelden

<!doctype html>
<meta charset="utf-8">
<title>MutationObserver options</title>
<script>
  const root = document.createElement("div");
  const item = document.createElement("span");
  const text = document.createTextNode("before");
  item.setAttribute("data-state", "idle");
  item.append(text);
  root.append(item);

  const observer = new MutationObserver((records, self) => {
    for (const record of records) {
      console.log(JSON.stringify([record.type, record.attributeName, record.oldValue]));
    }
    self.disconnect();
  });

  observer.observe(root, {
    childList: true,
    subtree: true,
    attributeFilter: ["data-state"],
    attributeOldValue: true,
    characterDataOldValue: true,
  });

  item.setAttribute("data-state", "ready");
  item.setAttribute("title", "ignored");
  text.data = "after";
  item.append(document.createElement("em"));
</script>

Resultaat

["attributes","data-state","idle"]
["characterData",null,"before"]
["childList",null,null]

Sla het volledige voorbeeld op als `.html`-bestand en open het in een browser. Open de ontwikkelaarsconsole en laad de pagina opnieuw. De knopen worden niet aan de pagina toegevoegd. Het filter sluit `title` uit en de opties voor oude waarden schakelen de weggelaten opties `attributes` en `characterData` in. De callback toont drie records in de volgorde van de wijzigingen en stopt daarna de observatie.

Gerelateerde lessen

  • JavaScript · Les 31 · Gemiddeld · Versie: 3

Bronnen