CKTIS / JavaScript
Elementos personalizados: atributos observados e ciclo de vida
Aprende como um elemento personalizado escolhe os atributos a observar e reage a alterações, à ligação a um documento e à respetiva separação.
Versão: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxe
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);Regista uma classe que estende HTMLElement com customElements.define(). O navegador passa a chamar os métodos do ciclo de vida nas instâncias. Durante o registo, lê a propriedade estática observedAttributes se attributeChangedCallback estiver definido. Basta um getter estático que devolva um array de nomes de atributos. Alterar esse array depois não modifica a lista registada.
attributeChangedCallback(name, oldValue, newValue, namespace) reage à adição, atribuição ou remoção de um atributo observado, mesmo quando o elemento está desligado. name é o nome local do atributo e namespace é o seu espaço de nomes ou null. Os valores dos atributos são cadeias de caracteres: ao adicionar, oldValue é null; ao remover, newValue é null. Atribuir novamente o mesmo valor também pode desencadear a chamada. Quando um elemento existente recebe a sua definição (upgrade), as reações aos atributos observados já presentes são colocadas em fila antes de uma eventual reação de ligação desse upgrade.
connectedCallback() e disconnectedCallback() não recebem argumentos. Reagem, respetivamente, à ligação a um documento e à separação do mesmo, incluindo quando é um antepassado que é inserido ou removido. Podem ser executados várias vezes na mesma instância; uma deslocação normal com insertBefore() pode desencadear ambos. Ao ligar, regista os ouvintes de eventos necessários ou inicia os temporizadores sem os duplicar. Ao desligar, remove esses ouvintes ou para esses temporizadores.
Estes mecanismos pertencem à plataforma web, não ao ECMAScript 2024. Usa-os num ambiente de execução com DOM e suporte para Custom Elements.
Exemplos
<!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
Na consola do navegador, a primeira alteração de `data-state` aparece antes de `connected`, e `data-note` não gera nenhuma linha. Ao remover `data-state`, o novo valor é `null`; ao reinserir o elemento, `connected` é acionado pela segunda vez.
Lições relacionadas
- JavaScript · Lição 38 · Intermédio · Versão: 3