CKTIS / JavaScript
MutationObserver: observe(), disconnect() a takeRecords()
Sledujte vybrané změny v DOM, vyzvedněte čekající záznamy bez čekání na zpětné volání a při ukončení sledování se rozhodněte, zda je zachováte.
Verze: ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
const observer = new MutationObserver(callback);
observer.observe(target, options);
const records = observer.takeRecords();
observer.disconnect();new MutationObserver(callback) vytvoří pozorovatele, ale ještě nespustí sledování. observe(target, options), disconnect() a takeRecords() jsou metody instance, nikoli statické metody. Odpovídající změny se ukládají do fronty a oznamovací mikroúloha je předá v dávce do callback(records, observer). Zpětné volání tedy neprobíhá synchronně při každé změně.
observe(target, options) zaregistruje uzel DOM (Node) a vrátí undefined. Další volání mohou přidávat cíle nebo měnit nastavení stejného cíle. childList sleduje přidávání a odebírání přímých potomků, attributes změny atributů a characterData změny dat uzlu, například obsahu textového uzlu. subtree: true použije stejná pravidla i na potomky. Změny v odebrané větvi se mohou stále zařadit do fronty před následující oznamovací mikroúlohou.
attributeFilter omezuje názvy sledovaných atributů. attributeOldValue: true a characterDataOldValue: true ukládají předchozí hodnotu do oldValue. Pokud attributes vynecháte, už samotné uvedení attributeFilter nebo attributeOldValue zapne sledování atributů. Uvedení characterDataOldValue obdobně zapne vynechanou volbu characterData. observe() vyvolá TypeError, pokud není zapnutý žádný typ změny, pokud zkombinujete attributes: false s filtrem či attributeOldValue: true nebo pokud zkombinujete characterData: false s characterDataOldValue: true.
takeRecords() synchronně vrátí pole čekajících objektů MutationRecord ([], je-li fronta prázdná) a vyprázdní frontu. Neukončí sledování ani nevyvolá zpětné volání; vrácené záznamy zpracujete sami. disconnect() vrátí undefined, ukončí sledování všech cílů této instance a zahodí nedoručené záznamy. Chcete-li si je ponechat, zavolejte takeRecords() těsně před disconnect(). Dalším voláním observe() můžete pozorovatele znovu použít.
Jde o rozhraní DOM webové platformy, nikoli o součást ECMAScriptu 2024. Dostupnost závisí na běhovém prostředí. Pozorovatel neumožní přístup k jinak nepřístupným uzlům, například uvnitř iframe s jiným původem.
Pří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ýsledek
taken: attributes data-state remaining: 0 callback: 1 data-state
Uložte celý příklad jako soubor HTML, otevřete ho v prohlížeči a zkontrolujte výstup ve vývojářské konzoli. Prvek se nevkládá do stránky. `takeRecords()` vyzvedne první záznam, `disconnect()` zahodí druhý a změna během přerušení se nezaznamená. Zpětné volání dostane jen změnu po obnovení sledování.
Související lekce
- JavaScript · Lekce 31 · Středně pokročilá · Verze: 3