CKTIS / JavaScript
Vlastní elementy: sledované atributy a životní cyklus
Zjisti, jak vlastní element vybírá atributy ke sledování a jak reaguje na jejich změny, připojení k dokumentu a odpojení od něj.
Verze: ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
class ExampleElement extends HTMLElement {
static get observedAttributes() {
return ["data-state"];
}
attributeChangedCallback(name, oldValue, newValue, namespace) {
// React to an observed attribute.
}
connectedCallback() {
// Start work that requires a document connection.
}
disconnectedCallback() {
// Stop that work and release external resources.
}
}
customElements.define("example-element", ExampleElement);Třídu odvozenou od HTMLElement zaregistruj pomocí customElements.define(). Prohlížeč potom sám volá metody životního cyklu na jejích instancích. Při registraci načte statickou vlastnost observedAttributes, pokud je definována metoda attributeChangedCallback. Stačí statický getter, který vrací pole názvů atributů. Pozdější úprava pole zaregistrovaný seznam nezmění.
attributeChangedCallback(name, oldValue, newValue, namespace) reaguje na přidání, nastavení nebo odebrání sledovaného atributu, i když element není připojený. name je lokální název atributu a namespace je jeho jmenný prostor nebo null. Hodnoty atributů jsou řetězce: při přidání je oldValue rovno null, při odebrání je newValue rovno null. Volání může vyvolat i opětovné nastavení stejné hodnoty. Když prohlížeč použije definici na již existující element (upgrade), zařadí reakce na přítomné sledované atributy do fronty před případnou reakcí na připojení v rámci tohoto upgradu.
connectedCallback() a disconnectedCallback() nepřijímají argumenty. Reagují na připojení k dokumentu a odpojení od něj, a to i při vložení nebo odebrání předka elementu. Na téže instanci mohou proběhnout opakovaně; běžný přesun pomocí insertBefore() může vyvolat obě metody. Při připojení přidej potřebné posluchače událostí nebo spusť časovače bez duplicit. Při odpojení tyto posluchače odeber nebo časovače zastav.
Tyto mechanismy patří do webové platformy, nikoli do ECMAScript 2024. Používej je v prostředí s DOM a podporou Custom Elements.
Příklady
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Custom element lifecycle demo</title>
</head>
<body>
<script>
(() => {
const log = [];
const tag = "cktis-lifecycle-demo";
class LifecycleDemo extends HTMLElement {
static get observedAttributes() {
return ["data-state"];
}
attributeChangedCallback(name, oldValue, newValue) {
log.push(`${name}: ${JSON.stringify(oldValue)} -> ${JSON.stringify(newValue)}`);
}
connectedCallback() {
log.push("connected");
}
disconnectedCallback() {
log.push("disconnected");
}
}
customElements.define(tag, LifecycleDemo);
const element = document.createElement(tag);
element.setAttribute("data-state", "idle");
document.body.append(element);
element.setAttribute("data-state", "ready");
element.setAttribute("data-note", "not observed");
element.removeAttribute("data-state");
element.remove();
document.body.append(element);
element.remove();
console.log(log.join("\n"));
})();
</script>
</body>
</html>Výsledek
data-state: null -> "idle" connected data-state: "idle" -> "ready" data-state: "ready" -> null disconnected connected disconnected
V konzoli prohlížeče se první změna `data-state` objeví před `connected` a `data-note` nevypíše žádný řádek. Po odebrání `data-state` je nová hodnota `null` a po opětovném vložení se `connected` vypíše podruhé.
Související lekce
- JavaScript · Lekce 38 · Středně pokročilá · Verze: 3