Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

Elementi personalizzati: attributi osservati e ciclo di vita

Scopri come un elemento personalizzato sceglie quali attributi osservare e come reagisce alle loro modifiche, alla connessione al documento e alla disconnessione.

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

Sintassi

class ExampleElement extends HTMLElement {
  static get observedAttributes() {
    return ["data-state"];
  }

  attributeChangedCallback(name, oldValue, newValue, namespace) {
    // React to an observed attribute.
  }

  connectedCallback() {
    // Start work that requires a document connection.
  }

  disconnectedCallback() {
    // Stop that work and release external resources.
  }
}

customElements.define("example-element", ExampleElement);

Registra con customElements.define() una classe che estende HTMLElement. Il browser richiama i metodi del ciclo di vita sulle sue istanze. Al momento della registrazione legge la proprietà statica observedAttributes se è definito attributeChangedCallback. Basta un getter statico che restituisca un array di nomi di attributi. Modificare l’array in seguito non cambia l’elenco registrato.

attributeChangedCallback(name, oldValue, newValue, namespace) reagisce quando un attributo osservato viene aggiunto, impostato o rimosso, anche se l’elemento è scollegato. name è il nome locale dell’attributo e namespace è il suo spazio dei nomi oppure null. I valori sono stringhe: all’aggiunta oldValue è null, mentre alla rimozione newValue è null. Anche impostare di nuovo lo stesso valore può attivare il callback. Quando a un elemento esistente viene applicata la sua definizione (upgrade), le reazioni per gli attributi osservati già presenti vengono accodate prima dell’eventuale reazione alla connessione dovuta all’upgrade.

connectedCallback() e disconnectedCallback() non ricevono argomenti. Rispondono rispettivamente alla connessione a un documento e alla disconnessione, anche se a essere inserito o rimosso è un antenato. Possono essere eseguiti più volte sulla stessa istanza; un normale spostamento con insertBefore() può attivarli entrambi. Alla connessione registra i listener necessari o avvia i timer senza duplicarli. Alla disconnessione rimuovi quei listener o interrompi quei timer.

Questi meccanismi fanno parte della piattaforma web, non di ECMAScript 2024. Usali in un ambiente di esecuzione con un DOM e il supporto per i Custom Elements.

Esempi

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Custom element lifecycle demo</title>
</head>
<body>
  <script>
    (() => {
      const log = [];
      const tag = "cktis-lifecycle-demo";

      class LifecycleDemo extends HTMLElement {
        static get observedAttributes() {
          return ["data-state"];
        }

        attributeChangedCallback(name, oldValue, newValue) {
          log.push(`${name}: ${JSON.stringify(oldValue)} -> ${JSON.stringify(newValue)}`);
        }

        connectedCallback() {
          log.push("connected");
        }

        disconnectedCallback() {
          log.push("disconnected");
        }
      }

      customElements.define(tag, LifecycleDemo);
      const element = document.createElement(tag);
      element.setAttribute("data-state", "idle");
      document.body.append(element);
      element.setAttribute("data-state", "ready");
      element.setAttribute("data-note", "not observed");
      element.removeAttribute("data-state");
      element.remove();
      document.body.append(element);
      element.remove();

      console.log(log.join("\n"));
    })();
  </script>
</body>
</html>

Risultato

data-state: null -> "idle"
connected
data-state: "idle" -> "ready"
data-state: "ready" -> null
disconnected
connected
disconnected

Nella console del browser, la prima modifica di `data-state` appare prima di `connected`, mentre `data-note` non produce righe. La rimozione di `data-state` dà `null` come nuovo valore; il reinserimento attiva `connected` una seconda volta.

Lezioni correlate

  • JavaScript · Lezione 38 · Intermedio · Versione: 3

Fonti