KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

Aangepaste elementen: bewaakte attributen en levenscyclus

Leer hoe een aangepast element kiest welke attributen het bewaakt en hoe het reageert op attribuutwijzigingen en op het verbinden met of loskoppelen van een document.

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

Syntax

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

Registreer met customElements.define() een klasse die HTMLElement uitbreidt. De browser roept de levenscyclusmethoden van de instanties zelf aan. Bij registratie leest hij de statische eigenschap observedAttributes als attributeChangedCallback is gedefinieerd. Een statische getter die een array met attribuutnamen teruggeeft, volstaat. Als je die array later wijzigt, verandert de geregistreerde lijst niet.

attributeChangedCallback(name, oldValue, newValue, namespace) reageert wanneer een bewaakt attribuut wordt toegevoegd, ingesteld of verwijderd, ook als het element losgekoppeld is. name is de lokale naam van het attribuut en namespace is de naamruimte ervan of null. Attribuutwaarden zijn tekenreeksen: bij toevoegen is oldValue gelijk aan null, bij verwijderen is newValue gelijk aan null. Ook het opnieuw instellen van dezelfde waarde kan de callback activeren. Als een bestaand element zijn definitie krijgt (upgrade), komen de reacties voor al aanwezige bewaakte attributen vóór een eventuele verbindingsreactie van die upgrade in de wachtrij.

connectedCallback() en disconnectedCallback() krijgen geen argumenten. Ze reageren respectievelijk op verbinding met en loskoppeling van een document, ook als een voorouder wordt ingevoegd of verwijderd. Ze kunnen meerdere keren op dezelfde instantie worden uitgevoerd; een gewone verplaatsing met insertBefore() kan beide activeren. Voeg bij het verbinden de benodigde listeners of timers toe zonder ze te dupliceren. Verwijder die listeners of stop die timers bij het loskoppelen.

Deze mechanismen horen bij het webplatform, niet bij ECMAScript 2024. Gebruik ze in een omgeving met een DOM en ondersteuning voor Custom Elements.

Voorbeelden

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

Resultaat

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

In de browserconsole verschijnt de eerste wijziging van `data-state` vóór `connected`; `data-note` levert geen regel op. Als je `data-state` verwijdert, is de nieuwe waarde `null`. Bij opnieuw invoegen verschijnt `connected` een tweede keer.

Gerelateerde lessen

  • JavaScript · Les 38 · Gemiddeld · Versie: 3

Bronnen