Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

Elementos personalizados: atributos observados y ciclo de vida

Aprende cómo un elemento personalizado elige qué atributos observar y cómo responde cuando estos cambian o cuando se conecta al documento o se desconecta de él.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

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 clase que extienda HTMLElement. El navegador llama entonces a los métodos del ciclo de vida de sus instancias. Durante el registro lee la propiedad estática observedAttributes si se ha definido attributeChangedCallback. Basta con un getter estático que devuelva un array de nombres de atributos. Modificar el array más tarde no cambia la lista registrada.

attributeChangedCallback(name, oldValue, newValue, namespace) responde cuando se añade, se establece o se elimina un atributo observado, aunque el elemento esté desconectado. name es el nombre local del atributo y namespace su espacio de nombres o null. Los valores de atributo son cadenas: al añadirlo, oldValue es null, y al eliminarlo, newValue es null. Volver a establecer el mismo valor también puede provocar la llamada. Cuando un elemento existente recibe su definición (actualización), las reacciones de los atributos observados que ya estaban presentes se ponen en cola antes de cualquier reacción de conexión de esa actualización.

connectedCallback() y disconnectedCallback() no reciben argumentos. Responden, respectivamente, a la conexión con un documento y a la desconexión, incluso si lo que se inserta o se elimina es un ancestro. Pueden ejecutarse varias veces en la misma instancia; un traslado normal con insertBefore() puede activar ambos. Al conectar, registra los escuchadores de eventos necesarios o inicia los temporizadores sin duplicarlos. Al desconectar, elimina esos escuchadores o detén esos temporizadores.

Estos mecanismos pertenecen a la plataforma web, no a ECMAScript 2024. Úsalos en un entorno con DOM y compatibilidad con Custom Elements.

Ejemplos

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

Resultado

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

En la consola del navegador, el primer cambio de `data-state` aparece antes de `connected`, y `data-note` no genera ninguna línea. Eliminar `data-state` da `null` como valor nuevo, y volver a insertar el elemento activa `connected` por segunda vez.

Lecciones relacionadas

  • JavaScript · Lección 38 · Intermedio · Versión: 3

Fuentes