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

CKTIS / JavaScript

Éléments personnalisés : attributs observés et cycle de vie

Découvrez comment un élément personnalisé choisit les attributs à observer et réagit à leur modification ainsi qu’à sa connexion au document ou à sa déconnexion.

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

Syntaxe

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);

Enregistrez une classe qui hérite de HTMLElement avec customElements.define(). Le navigateur appelle alors les méthodes du cycle de vie sur ses instances. Lors de l’enregistrement, il lit la propriété statique observedAttributes si attributeChangedCallback est défini. Un accesseur statique qui renvoie un tableau de noms d’attributs suffit. Modifier ce tableau ensuite ne change pas la liste enregistrée.

attributeChangedCallback(name, oldValue, newValue, namespace) réagit à l’ajout, à l’affectation ou à la suppression d’un attribut observé, même si l’élément est détaché. name est le nom local de l’attribut, et namespace son espace de noms ou null. Les valeurs d’attribut sont des chaînes : à l’ajout, oldValue vaut null ; à la suppression, newValue vaut null. Réaffecter la même valeur peut aussi déclencher ce rappel. Quand un élément existant reçoit sa définition (mise à niveau), les réactions pour les attributs observés déjà présents sont mises en file avant une éventuelle réaction de connexion liée à cette mise à niveau.

connectedCallback() et disconnectedCallback() ne reçoivent aucun argument. Ils réagissent respectivement à la connexion au document et à la déconnexion, y compris lorsqu’un ancêtre est inséré ou supprimé. Ils peuvent s’exécuter plusieurs fois sur une même instance ; un déplacement ordinaire avec insertBefore() peut déclencher les deux. À la connexion, ajoutez les écouteurs nécessaires ou lancez les minuteurs sans les dupliquer ; à la déconnexion, retirez ces écouteurs ou arrêtez ces minuteurs.

Ces mécanismes relèvent de la plateforme web, pas d’ECMAScript 2024. Utilisez-les dans un environnement doté d’un DOM et prenant en charge les Custom Elements.

Exemples

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

Résultat

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

Dans la console du navigateur, la première modification de `data-state` s’affiche avant `connected`, et `data-note` ne produit aucune ligne. La suppression de `data-state` donne `null` comme nouvelle valeur, et la réinsertion déclenche `connected` une deuxième fois.

Leçons associées

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

Sources