WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Web Components: eigene Elemente und Lebenszyklus

Web Components sind Mechanismen der Webplattform zum Erstellen eigener Oberflächenelemente. Erfahre, wie du eine von HTMLElement abgeleitete Klasse registrierst, auf das Einfügen und Entfernen eines Elements reagierst und Attribute beobachtest. Dies sind Browser-APIs, keine Funktionen von ECMAScript selbst.

Version: Web-platform APIs, not tied to an ECMAScript edition. The example's exact console output was verified in isolated Chromium 157.0.8103.51 only; this does not establish broader browser compatibility. Node 24 in the repository does not establish browser API support.

Syntax

class ExampleElement extends HTMLElement {
  static get observedAttributes() { return ['label']; }
  connectedCallback() { /* initialize or resume */ }
  disconnectedCallback() { /* release external resources */ }
  attributeChangedCallback(name, oldValue, newValue) { /* react to an observed attribute */ }
}
customElements.define('example-element', ExampleElement);

Web Components umfassen eigene Elemente (custom elements), Shadow DOM sowie Vorlagen und Slots. Diese Mechanismen lassen sich kombinieren, aber ein eigenes Element benötigt kein Shadow DOM. Ein autonomes eigenes Element ist eine Instanz einer von HTMLElement abgeleiteten Klasse. customElements.define() registriert den Konstruktor dieser Klasse unter dem Elementnamen. Ein gültiger Name muss einen Bindestrich enthalten, etwa cktis-greeting.

Rufe im Konstruktor super() auf, bevor du this verwendest; dort kann mit attachShadow() ein Shadow Root erstellt werden. connectedCallback() behandelt das Einfügen in das Dokument, disconnectedCallback() das Entfernen. Das Einfügen kann wiederholt stattfinden: Vermeide doppelte Listener oder Timer und gib beim Entfernen externe Ressourcen frei. Shadow DOM kapselt Struktur und Styles, ist aber keine Sicherheitsgrenze.

Das statische observedAttributes legt fest, welche Attributnamen beobachtet werden. attributeChangedCallback(name, oldValue, newValue) reagiert auf deren Hinzufügen, Ändern oder Entfernen; der Aufruf kann erfolgen, bevor das Element eingefügt ist. Ein fehlender Wert wird durch null dargestellt. Das Ändern einer gewöhnlichen JavaScript-Eigenschaft ändert nicht automatisch ein Attribut. Das Beispiel verwendet textContent, um Text anzuzeigen, ohne ihn als HTML zu interpretieren.

Die aufgeführten Quellen konzentrieren sich auf eigene Elemente und HTMLElement: Der WHATWG HTML Living Standard spezifiziert eigene Elemente, und die MDN-Dokumentation beschreibt HTMLElement und erklärt, wie man eigene Elemente verwendet. Die exakte Konsolenausgabe des Beispiels wurde nur in einer isolierten Instanz von Chromium 157.0.8103.51 überprüft. Das belegt keine Kompatibilität mit anderen Browsern oder Versionen; prüfe daher die API-Unterstützung in den vorgesehenen Browsern. Keine einzelne ECMAScript-Ausgabe garantiert Web Components; auch Node 24 im Repository belegt nicht, dass die APIs verfügbar sind. Das Beispiel benötigt eine Browserumgebung.

Beispiele

(() => {
  class CktisGreeting extends HTMLElement {
    static get observedAttributes() {
      return ['label'];
    }

    constructor() {
      super();
      this.attachShadow({ mode: 'open' });
    }

    connectedCallback() {
      this.render();
    }

    disconnectedCallback() {
      console.log('disconnected');
    }

    attributeChangedCallback(name, oldValue, newValue) {
      if (oldValue !== newValue) this.render();
    }

    render() {
      this.shadowRoot.textContent = `Hello, ${this.getAttribute('label') ?? 'world'}!`;
    }
  }

  if (customElements.get('cktis-greeting')) {
    throw new Error('Reload the page before running this example again.');
  }
  customElements.define('cktis-greeting', CktisGreeting);

  const element = document.createElement('cktis-greeting');
  document.body.append(element);
  console.log(element.shadowRoot.textContent);
  element.setAttribute('label', 'Ada');
  console.log(element.shadowRoot.textContent);
  element.remove();
})();

Ergebnis

Hello, world!
Hello, Ada!
disconnected

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen