CKTIS / JavaScript
ID-Suche und Fokus: getElementById() und activeElement
`document.getElementById(id)` sucht ein Element anhand seiner ID. `document.activeElement` zeigt, wo aus Sicht des Dokuments gerade der Tastaturfokus liegt.
Version: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
document.getElementById(id) // call: Element or null
document.activeElement // read-only property: Element or nulldocument.getElementById(id) ist eine Methode, die im Baum des jeweiligen Dokuments nach einer id sucht. Übergib die ID selbst ohne das CSS-Selektorpräfix #. Groß- und Kleinschreibung sind relevant. Die Methode liefert ein Element oder null, wenn es keinen Treffer gibt. IDs sollen innerhalb eines Baums eindeutig sein; bei Duplikaten liefert die Methode den ersten Treffer in Baumreihenfolge.
Die Suche erfasst keine vom Dokument getrennten Knoten und dringt weder in Shadow-DOM-Bäume noch in Dokumente innerhalb von iframe-Elementen ein. DocumentFragment und damit auch ShadowRoot verfügen über eine eigene Methode getElementById(); ein gewöhnliches Element hingegen nicht. Prüfe das Ergebnis vor der Verwendung auf null oder nutze ?., wenn das Element fehlen darf.
document.activeElement ist eine schreibgeschützte Eigenschaft, keine Methode. Sie liefert das Element, das aus Sicht dieses Dokuments den aktuellen Tastaturfokus repräsentiert. Liegt der Fokus in einem Shadow-DOM-Baum oder in einem eingebetteten Dokument, sieht das äußere Dokument den Shadow-Host beziehungsweise das iframe. Um weiter nach innen zu schauen, lies activeElement an einem zugänglichen ShadowRoot oder am Dokument des Frames mit gleicher Origin. Fällt der Fokus auf das Dokument selbst, liefert die Eigenschaft dessen body, ersatzweise documentElement, sofern vorhanden. Gibt es im abgefragten Baum weder ein passendes Element noch einen Ersatzwert, ist das Ergebnis null.
Fokus ist keine Textauswahl, und die Suche setzt keinen Fokus. Ist target nicht null, prüft document.activeElement === target die Identität des Knotens. Lies die Eigenschaft nach einem Fokuswechsel erneut: Ein gespeicherter Wert aktualisiert sich nicht von selbst. Beide APIs gehören zur Webplattform, nicht zu ECMAScript 2024; eine Laufzeit ohne Browser-DOM muss document nicht bereitstellen.
Beispiele
<!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>Ergebnis
true false true true
Speichere das Beispiel als HTML-Datei, öffne sie in einem Browser-Tab im Vordergrund und prüfe anschließend die Browserkonsole. Wenn der Browser programmgesteuerten Fokus zulässt, zeigen die ersten drei Zeilen, dass das Zielelement gefunden wird, zunächst nicht fokussiert ist und dann den Fokus erhält. Die letzte Zeile bestätigt, dass eine andere Großschreibung den Treffer verhindert.
Zugehörige Lektionen
- JavaScript · Lektion 18 · Fortgeschritten · Version: 4