Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

`disconnectedCallback()` di un elemento personalizzato

Usa `disconnectedCallback()` per liberare le risorse legate alla connessione di un elemento personalizzato a un documento senza impedirne la riconnessione.

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

Sintassi

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

disconnectedCallback() è un metodo di istanza facoltativo del ciclo di vita di un elemento personalizzato registrato. Il browser lo chiama senza argomenti, con l’elemento come valore di this, quando l’elemento perde la connessione a un documento, per esempio se viene rimosso un antenato. Nascondere l’elemento o crearlo senza inserirlo non attiva il metodo. Il metodo appartiene alla piattaforma web, non a ECMAScript 2024.

Avvia le attività legate alla connessione in connectedCallback() e interrompile in disconnectedCallback(): ferma i timer, scollega gli osservatori e rimuovi i listener di eventi dai target esterni. Per removeEventListener() usa lo stesso target, tipo di evento, oggetto funzione e valore di capture usati nella registrazione. La disconnessione non distrugge l’istanza: può essere riconnessa, quindi la pulizia deve poter essere ripetuta senza problemi.

Un normale spostamento all’interno di un documento con Node.insertBefore() può attivare disconnectedCallback() e poi connectedCallback(). Se il browser supporta Element.moveBefore() e l’elemento definisce connectedMoveCallback(), uno spostamento che conserva lo stato tramite questa API chiama quest’ultimo metodo al posto degli altri due. Verifica il supporto nei browser di destinazione.

Esempi

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

Risultato

1, 1, 2, 2

Salva il codice completo in un file HTML e aprilo in un browser. Entrambi gli inserimenti usano la stessa istanza. Un evento `ping` incrementa il contatore solo quando l’elemento è connesso. L’output atteso è `1, 1, 2, 2`.

Lezioni correlate

  • JavaScript · Lezione 39 · Intermedio · Versione: 3

Fonti