WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

`disconnectedCallback()` für benutzerdefinierte Elemente

Mit `disconnectedCallback()` gibst du Ressourcen frei, die an die Verbindung eines benutzerdefinierten Elements mit einem Dokument gebunden sind, ohne eine erneute Verbindung zu verhindern.

Version: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

class MyElement extends HTMLElement {
  disconnectedCallback() {
    // Release resources tied to the current connection.
  }
}
customElements.define("my-element", MyElement);

disconnectedCallback() ist eine optionale Lebenszyklusmethode der Instanz eines registrierten benutzerdefinierten Elements. Der Browser ruft sie ohne Argumente auf, mit dem Element als this, wenn es seine Verbindung zu einem Dokument verliert, etwa weil ein Vorfahr entfernt wurde. Bloßes Ausblenden oder Erstellen ohne Einfügen löst den Aufruf nicht aus. Die Methode gehört zur Webplattform, nicht zu ECMAScript 2024.

Starte Arbeiten, die eine Verbindung zum Dokument voraussetzen, in connectedCallback() und beende sie in disconnectedCallback(): Stoppe Timer, trenne Beobachter und entferne Ereignis-Listener von externen Zielen. Bei removeEventListener() müssen Ziel, Ereignistyp, Funktionsobjekt und capture-Wert mit der Registrierung übereinstimmen. Die Instanz wird beim Trennen nicht zerstört und kann erneut verbunden werden. Sorge dafür, dass sich die Aufräumarbeiten gefahrlos wiederholen lassen.

Ein gewöhnliches Verschieben innerhalb eines Dokuments mit Node.insertBefore() kann erst disconnectedCallback() und dann connectedCallback() auslösen. Unterstützt der Browser Element.moveBefore() und definiert das Element connectedMoveCallback(), wird bei einem zustandserhaltenden Verschieben mit dieser API stattdessen connectedMoveCallback() aufgerufen. Prüfe die Unterstützung in den Zielbrowsern.

Beispiele

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Custom element disconnection</title>
</head>
<body>
  <pre id="result"></pre>
  <script>
    const source = new EventTarget();
    let count = 0;

    class CktisPingCounter extends HTMLElement {
      #onPing = () => { count += 1; };

      connectedCallback() {
        source.addEventListener("ping", this.#onPing);
      }

      disconnectedCallback() {
        source.removeEventListener("ping", this.#onPing);
      }
    }

    customElements.define("cktis-ping-counter", CktisPingCounter);
    const counter = document.createElement("cktis-ping-counter");
    const counts = [];
    const probe = () => {
      source.dispatchEvent(new Event("ping"));
      counts.push(count);
    };

    document.body.append(counter);
    probe();
    counter.remove();
    probe();
    document.body.append(counter);
    probe();
    counter.remove();
    probe();

    const output = counts.join(", ");
    document.getElementById("result").textContent = output;
    console.log(output);
  </script>
</body>
</html>

Ergebnis

1, 1, 2, 2

Speichere den vollständigen Code als HTML-Datei und öffne sie in einem Browser. Beide Einfügungen verwenden dieselbe Instanz. Ein `ping` erhöht den Zähler nur, solange das Element verbunden ist. Die erwartete Ausgabe lautet `1, 1, 2, 2`.

Zugehörige Lektionen

  • JavaScript · Lektion 39 · Mittlere Stufe · Version: 3

Quellen