Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

`disconnectedCallback()` pour un élément personnalisé

Utilisez `disconnectedCallback()` pour libérer les ressources liées à la connexion d’un élément personnalisé à un document, sans empêcher sa reconnexion.

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

Syntaxe

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

disconnectedCallback() est une méthode d’instance facultative du cycle de vie d’un élément personnalisé enregistré. Le navigateur l’appelle sans argument, avec l’élément comme valeur de this, lorsque celui-ci cesse d’être connecté à un document, par exemple si un ancêtre est retiré. Masquer l’élément ou le créer sans l’insérer ne déclenche pas cet appel. Cette méthode relève de la plateforme web, pas d’ECMAScript 2024.

Démarrez les tâches liées à la connexion dans connectedCallback() et arrêtez-les dans disconnectedCallback() : arrêtez les temporisateurs, déconnectez les observateurs et retirez les écouteurs des cibles externes. Pour removeEventListener(), utilisez la même cible, le même type d’événement, le même objet fonction et la même valeur de capture qu’à l’enregistrement. La déconnexion ne détruit pas l’instance : elle peut être reconnectée. Le nettoyage doit donc pouvoir être répété sans risque.

Un déplacement ordinaire dans un document avec Node.insertBefore() peut déclencher disconnectedCallback(), puis connectedCallback(). Si le navigateur prend en charge Element.moveBefore() et que l’élément définit connectedMoveCallback(), un déplacement qui conserve l’état avec cette API appelle cette dernière méthode à la place des deux autres. Vérifiez la prise en charge dans les navigateurs ciblés.

Exemples

<!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>

Résultat

1, 1, 2, 2

Enregistrez le code complet dans un fichier HTML et ouvrez-le dans un navigateur. Les deux insertions utilisent la même instance. Un événement `ping` n’augmente le compteur que lorsque l’élément est connecté. La sortie attendue est `1, 1, 2, 2`.

Leçons associées

  • JavaScript · Leçon 39 · Intermédiaire · Version : 3

Sources