Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / JavaScript

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

Sledujte vybrané zmeny v DOM, získajte čakajúce záznamy bez čakania na spätné volanie a pri ukončení sledovania sa rozhodnite, či si ich ponecháte.

Verzia: 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) vytvorí pozorovateľa, ale ešte nezačne sledovať zmeny. observe(target, options), disconnect() a takeRecords() sú metódy inštancie, nie statické metódy. Zodpovedajúce zmeny sa ukladajú do frontu a notifikačná mikroúloha ich odovzdá v dávke do callback(records, observer), takže sa funkcia nevolá synchrónne pri každej zmene.

observe(target, options) zaregistruje uzol DOM (Node) a vráti undefined. Ďalšie volania môžu pridať iné ciele alebo upraviť možnosti toho istého cieľa. childList sleduje pridávanie a odoberanie priamych potomkov, attributes sleduje zmeny atribútov a characterData zmeny údajov uzla, napríklad obsahu textového uzla. subtree: true použije rovnaké pravidlá aj na potomkov. Zmeny v odstránenej vetve sa ešte môžu dostať do frontu pred najbližšou notifikačnou mikroúlohou.

attributeFilter obmedzuje názvy sledovaných atribútov. attributeOldValue: true a characterDataOldValue: true ukladajú predchádzajúcu hodnotu do oldValue. Ak vynecháte attributes, už uvedenie attributeFilter alebo attributeOldValue zapne sledovanie atribútov. Uvedenie characterDataOldValue podobne zapne vynechanú voľbu characterData. observe() vyvolá TypeError, ak nie je zapnutý žiadny typ zmeny, ak pri attributes: false uvediete filter alebo attributeOldValue: true, alebo ak pri characterData: false nastavíte characterDataOldValue: true.

takeRecords() synchrónne vráti pole čakajúcich objektov MutationRecord ([], ak je front prázdny) a vyprázdni front. Nezastaví sledovanie ani nespustí spätné volanie: vrátené záznamy spracujete sami. disconnect() vráti undefined, zastaví sledovanie všetkých cieľov danej inštancie a zahodí nedoručené záznamy. Ak si ich chcete ponechať, zavolajte takeRecords() tesne pred disconnect(). Ďalším volaním observe() môžete pozorovateľa znova použiť.

Ide o rozhranie DOM webovej platformy, nie o súčasť ECMAScriptu 2024. Dostupnosť závisí od behového prostredia. Pozorovateľ neposkytuje prístup k inak neprístupným uzlom, napríklad v iframe s iným pôvodom.

Príklady

<!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>

Výsledok

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

Uložte celý príklad ako súbor HTML, otvorte ho v prehliadači a skontrolujte výstup vo vývojárskej konzole. Prvok sa nevkladá do stránky. `takeRecords()` získa prvý záznam, `disconnect()` zahodí druhý a zmena počas prerušenia sa nezaznamená. Spätné volanie dostane iba zmenu po obnovení sledovania.

Súvisiace lekcie

  • JavaScript · Lekcia 31 · Stredne pokročilá · Verzia: 3

Zdroje