Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

Elementy niestandardowe: obserwowanie atrybutów i cykl życia

Dowiedz się, jak element niestandardowy wybiera obserwowane atrybuty i reaguje na ich zmiany, podłączenie do dokumentu oraz odłączenie.

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

Składnia

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

Po zarejestrowaniu klasy dziedziczącej po HTMLElement za pomocą customElements.define() przeglądarka sama wywołuje metody cyklu życia na instancjach. Podczas rejestracji odczytuje statyczną właściwość observedAttributes, jeśli zdefiniowano attributeChangedCallback. Statyczny getter zwracający tablicę nazw atrybutów wystarczy. Późniejsza zmiana tej tablicy nie zmienia zapisanej listy.

attributeChangedCallback(name, oldValue, newValue, namespace) reaguje na dodanie, ustawienie lub usunięcie obserwowanego atrybutu, nawet gdy element jest odłączony. name to nazwa lokalna atrybutu, a namespace to jego przestrzeń nazw lub null. Wartości atrybutu są ciągami znaków: przy dodaniu oldValue ma wartość null, a przy usunięciu newValue ma wartość null. Ustawienie tej samej wartości może również wywołać tę metodę. Gdy przeglądarka zastosuje definicję do istniejącego elementu, reakcje na obecne już obserwowane atrybuty są kolejkowane przed ewentualną reakcją na podłączenie.

connectedCallback() i disconnectedCallback() nie przyjmują argumentów. Reagują odpowiednio na podłączenie do dokumentu i odłączenie od niego, również wtedy, gdy operacja dotyczy przodka elementu. Mogą uruchamiać się wielokrotnie na tej samej instancji; zwykłe przeniesienie przez insertBefore() może wywołać obie metody. Przy podłączeniu uruchamiaj potrzebne nasłuchiwanie zdarzeń lub timery bez ich dublowania, a przy odłączeniu usuwaj te nasłuchy lub zatrzymuj timery.

To mechanizmy platformy webowej, a nie część ECMAScript 2024. Używaj ich w środowisku z DOM i obsługą Custom Elements.

Przykłady

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

Wynik

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

W konsoli przeglądarki pierwsza zmiana `data-state` pojawia się przed `connected`, a `data-note` niczego nie wypisuje. Usunięcie `data-state` daje `null` jako nową wartość, a ponowne wstawienie uruchamia `connected` po raz drugi.

Powiązane lekcje

  • JavaScript · Lekcja 38 · Średniozaawansowany · Wersja: 3

Źródła