WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Ein Element per ID finden und auf die Dokumentsichtbarkeit reagieren

Finde ein Element mit `getElementById()`, lies den Sichtbarkeitszustand über `document.hidden` und aktualisiere die Oberfläche bei `visibilitychange`.

Version: Current web platform; runtime support varies

Syntax

// Browser DOM and HTML APIs; support depends on the browser, not on the ECMAScript edition.
document.getElementById(id) // Element | null
// Read-only visibility properties:
document.hidden // boolean
document.visibilityState // "hidden" | "visible"
// Register and later remove the same listener:
document.addEventListener("visibilitychange", handler)
document.removeEventListener("visibilitychange", handler)

document.getElementById(id) erwartet den ID-Wert ohne # und unterscheidet Groß- und Kleinschreibung. Die Methode liefert ein passendes Element im Dokumentbaum oder null, wenn es keines gibt. IDs sollten eindeutig sein; bei Duplikaten zählt der erste Treffer in Baumreihenfolge. Suche erst nach dem Einfügen und prüfe das Ergebnis vor einem Eigenschaftszugriff: Ein Zugriff auf null löst einen TypeError aus.

document.hidden ist eine schreibgeschützte boolesche Eigenschaft und entspricht document.visibilityState === "hidden". Der Zustand ist "hidden" oder "visible" und kann sich etwa beim Tabwechsel ändern. Er sagt nicht, ob ein bestimmtes Element im sichtbaren Seitenbereich liegt oder ob die Seite den Fokus hat. HTMLElement.hidden betrifft ein einzelnes Element und ändert den Sichtbarkeitszustand des Dokuments nicht.

Der Browser löst visibilitychange nach der Zustandsänderung auf document aus. Dieses Event lässt sich nicht abbrechen und enthält den neuen Zustand nicht; lies ihn im Handler am Dokument ab. Registriere den Handler und rufe ihn einmal auf, um die Oberfläche zu initialisieren. Beim Abbau einer Komponente entfernst du den Listener am selben Dokument mit derselben Funktion und capture-Einstellung.

Ist das Dokument verborgen, kannst du unnötige Arbeit pausieren. Der Zustand ist aber kein Nachweis dafür, dass die Seite verlassen wurde, dass jemand aufmerksam ist oder dass eine Berechtigung vorliegt. Diese APIs gehören zur Webplattform, nicht zu ECMAScript 2024. Ohne Browser-DOM ist document möglicherweise nicht verfügbar; die Unterstützung hängt von der Laufzeitumgebung ab.

Beispiele

(() => {
  function mount(document) {
    const id = "cktis-page-visibility-status";
    const status = document.createElement("p");
    status.id = id;
    document.body.append(status);

    function render(event) {
      const element = document.getElementById(id);
      if (element === null) return;

      element.textContent = document.hidden ? "hidden" : "visible";
      if (event) console.log(element.textContent);
    }

    document.addEventListener("visibilitychange", render);
    render();
    console.log("ready");
  }

  if (typeof document !== "undefined") {
    mount(document);
    return;
  }

  // Node.js fixture: model only the document operations used above.
  class TestDocument extends EventTarget {
    #elements = [];
    #hidden = false;

    body = { append: (element) => this.#elements.push(element) };

    createElement(tagName) {
      return { tagName, id: "", textContent: "" };
    }

    getElementById(id) {
      return this.#elements.find((element) => element.id === id) ?? null;
    }

    get hidden() {
      return this.#hidden;
    }

    setHidden(hidden) {
      if (this.#hidden === hidden) return;
      this.#hidden = hidden;
      this.dispatchEvent(new Event("visibilitychange"));
    }
  }

  const testDocument = new TestDocument();
  mount(testDocument);
  testDocument.setHidden(true);
  testDocument.setHidden(false);
})();

Ergebnis

ready
hidden
visible

Füge den Code einmal in die Konsole eines neuen, aktiven `about:blank`-Tabs ein. Prüfe `ready`, wechsle den Tab, warte kurz und kehre zurück. Meldet der Browser beide Wechsel, erscheint zuerst `hidden` und dann `visible` in der Konsole; im Absatz steht wieder `visible`. Lade den Tab zum Zurücksetzen neu. Um den Handler in Node.js zu prüfen, speichere den Code als `main.js` und führe `node main.js` aus. Ein Testdokument simuliert beide Wechsel.

Zugehörige Lektionen

  • JavaScript · Lektion 13 · Fortgeschritten · Version: 4

Quellen