Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

`disconnectedCallback()` de um elemento personalizado

Utiliza `disconnectedCallback()` para libertar os recursos associados à ligação de um elemento personalizado a um documento, sem impedir que volte a ligar-se.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

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

disconnectedCallback() é um método de instância opcional do ciclo de vida de um elemento personalizado registado. O navegador chama-o sem argumentos, com o elemento como valor de this, quando este deixa de estar ligado a um documento, por exemplo se um antepassado for removido. Ocultar o elemento ou criá-lo sem o inserir não desencadeia a chamada. O método faz parte da plataforma Web, não de ECMAScript 2024.

Inicia o trabalho associado à ligação em connectedCallback() e termina-o em disconnectedCallback(): para temporizadores, desliga observadores e remove os ouvintes de eventos de alvos externos. Em removeEventListener(), usa o mesmo alvo, tipo de evento, objeto de função e valor de capture usados no registo. Desligar o elemento não destrói a instância: esta pode voltar a ligar-se, pelo que a limpeza deve poder repetir-se sem problemas.

Uma deslocação normal dentro de um documento com Node.insertBefore() pode desencadear disconnectedCallback() e depois connectedCallback(). Se o navegador suportar Element.moveBefore() e o elemento definir connectedMoveCallback(), uma deslocação que preserve o estado com essa API chama este último método em vez dos outros dois. Verifica o suporte nos navegadores de destino.

Exemplos

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

Resultado

1, 1, 2, 2

Guarda o código completo num ficheiro HTML e abre-o num navegador. As duas inserções usam a mesma instância. Um evento `ping` só aumenta o contador enquanto o elemento está ligado. O resultado esperado é `1, 1, 2, 2`.

Lições relacionadas

  • JavaScript · Lição 39 · Intermédio · Versão: 3

Fontes