Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

Pesquisa por ID e foco: getElementById() e activeElement

`document.getElementById(id)` procura um elemento pelo identificador, enquanto `document.activeElement` indica onde está o foco do teclado na perspetiva do documento.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

document.getElementById(id) // call: Element or null
document.activeElement     // read-only property: Element or null

document.getElementById(id) é um método que procura um valor id na árvore do documento em causa. Passa apenas o identificador, sem o prefixo # dos seletores CSS. A pesquisa distingue maiúsculas de minúsculas. O método devolve um Element ou null se não houver correspondências. Os IDs devem ser únicos dentro da árvore; em caso de duplicados, o método devolve a primeira correspondência na ordem da árvore.

A pesquisa exclui nós que não estão ligados ao documento e não entra em árvores do Shadow DOM nem nos documentos de elementos iframe. DocumentFragment, e por isso também ShadowRoot, tem o seu próprio método getElementById(); um Element comum não o tem. Verifica se o resultado é null antes de o usar ou utiliza ?. se o elemento puder estar ausente.

document.activeElement é uma propriedade só de leitura, não um método. Devolve o Element que representa o foco atual do teclado na perspetiva do documento. Se o foco estiver numa árvore do Shadow DOM ou num documento incorporado, o documento exterior vê, respetivamente, o elemento anfitrião do Shadow DOM ou o iframe. Para consultar o interior, lê activeElement num ShadowRoot acessível ou no documento do iframe se tiver a mesma origem. Se o foco corresponder ao próprio documento, a propriedade devolve o seu body ou, na sua ausência, documentElement, se existir. Devolve null quando não há elemento nem valor alternativo aplicável na árvore consultada.

O foco não é a seleção de texto e procurar um elemento não lhe dá o foco. Se target não for null, document.activeElement === target verifica se se trata do mesmo nó. Volta a ler a propriedade depois de uma mudança de foco: um valor guardado não se atualiza por si só. São API da plataforma Web, não funcionalidades do ECMAScript 2024; um ambiente de execução sem o DOM do navegador não tem de disponibilizar document.

Exemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>ID lookup and focus</title>
</head>
<body>
<script>
{
  const other = document.createElement('input');
  const target = document.createElement('input');
  target.id = 'cktis-target';
  document.body.append(other, target);

  try {
    const found = document.getElementById('cktis-target');
    other.focus();
    console.log(found === target);
    console.log(found === document.activeElement);

    found?.focus();
    console.log(found === document.activeElement);
    console.log(document.getElementById('CKTIS-target') === null);
  } finally {
    other.remove();
    target.remove();
  }
}
</script>
</body>
</html>

Resultado

true
false
true
true

Guarda o exemplo como ficheiro HTML, abre-o num separador do navegador em primeiro plano e consulta depois a consola do navegador. Se o navegador permitir definir o foco por código, as primeiras três linhas mostram que o elemento é encontrado, inicialmente não tem o foco e depois o recebe. A última linha confirma que a mudança de maiúsculas impede a correspondência.

Lições relacionadas

  • JavaScript · Lição 18 · Avançado · Versão: 4

Fontes