CKTIS / JavaScript
Benutzerdefinierte Elemente: beobachtete Attribute und Lebenszyklus
Lerne, wie ein benutzerdefiniertes Element Attribute zur Beobachtung auswählt und auf Attributänderungen sowie auf das Verbinden und Trennen vom Dokument reagiert.
Version: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
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);Registriere eine von HTMLElement abgeleitete Klasse mit customElements.define(). Der Browser ruft die Lebenszyklusmethoden der Instanzen selbst auf. Bei der Registrierung liest er die statische Eigenschaft observedAttributes, sofern attributeChangedCallback definiert ist. Ein statischer Getter, der ein Array mit Attributnamen zurückgibt, genügt. Spätere Änderungen am Array wirken sich nicht auf die registrierte Liste aus.
attributeChangedCallback(name, oldValue, newValue, namespace) reagiert, wenn ein beobachtetes Attribut hinzugefügt, gesetzt oder entfernt wird, auch wenn das Element nicht mit dem Dokument verbunden ist. name ist der lokale Name des Attributs, namespace sein Namensraum oder null. Attributwerte sind Zeichenketten: Beim Hinzufügen ist oldValue gleich null, beim Entfernen ist newValue gleich null. Auch das erneute Setzen desselben Werts kann den Callback auslösen. Erhält ein vorhandenes Element seine Definition nachträglich (Upgrade), werden Reaktionen für bereits vorhandene beobachtete Attribute vor einer etwaigen Verbindungsreaktion eingereiht.
connectedCallback() und disconnectedCallback() erhalten keine Argumente. Sie reagieren darauf, dass das Element mit einem Dokument verbunden oder davon getrennt wird, auch wenn ein Vorfahr eingefügt oder entfernt wird. Beide können für dieselbe Instanz mehrfach laufen; ein gewöhnliches Verschieben mit insertBefore() kann beide auslösen. Registriere beim Verbinden benötigte Listener und starte Timer ohne Duplikate. Entferne die Listener oder stoppe die Timer beim Trennen.
Diese Mechanismen gehören zur Webplattform, nicht zu ECMAScript 2024. Die Laufzeitumgebung muss ein DOM und Custom Elements unterstützen.
Beispiele
<!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>Ergebnis
data-state: null -> "idle" connected data-state: "idle" -> "ready" data-state: "ready" -> null disconnected connected disconnected
In der Browserkonsole erscheint die erste Änderung von `data-state` vor `connected`; für `data-note` gibt es keine Zeile. Beim Entfernen von `data-state` ist der neue Wert `null`, und beim erneuten Einfügen erscheint `connected` ein zweites Mal.
Zugehörige Lektionen
- JavaScript · Lektion 38 · Mittlere Stufe · Version: 3