Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

Trovare un elemento per ID e reagire alla visibilità del documento

Trova un elemento con `getElementById()`, leggi lo stato di visibilità tramite `document.hidden` e aggiorna l’interfaccia con `visibilitychange`.

Versione: Current web platform; runtime support varies

Sintassi

// 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) riceve il valore dell’ID senza il prefisso # e distingue maiuscole e minuscole. Restituisce un Element corrispondente nell’albero del documento o null se non lo trova. Gli ID devono essere univoci; se ci sono duplicati, viene restituito il primo elemento nell’ordine dell’albero. Cerca l’elemento dopo averlo inserito e controlla il risultato prima di accedere alle proprietà: leggere una proprietà di null genera un TypeError.

document.hidden è una proprietà booleana di sola lettura, equivalente a document.visibilityState === "hidden". Lo stato del documento è "hidden" o "visible" e può cambiare, per esempio, quando passi a un’altra scheda. Non indica se un elemento specifico si trova nell’area visibile né se la pagina ha il focus. HTMLElement.hidden riguarda un singolo elemento e non modifica lo stato di visibilità del documento.

Il browser genera visibilitychange su document dopo il cambio di stato. È un Event non annullabile che non contiene il nuovo stato: leggilo dal documento nel gestore. Registra il gestore e chiamalo una volta per inizializzare l’interfaccia. Quando smonti un componente, rimuovi il listener dallo stesso documento con la stessa funzione e lo stesso valore di capture.

Sospendi le attività non necessarie mentre il documento è nascosto, ma non usare questo stato per stabilire se la pagina è stata abbandonata, se l’utente sta prestando attenzione o se è autorizzato. Queste API appartengono alla piattaforma web, non a ECMAScript 2024. Un ambiente senza DOM del browser potrebbe non fornire document; il supporto dipende dall’ambiente di esecuzione.

Esempi

(() => {
  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);
})();

Risultato

ready
hidden
visible

Incolla il codice una volta nella console di una nuova scheda attiva con `about:blank`. Controlla che appaia `ready`, cambia scheda, aspetta un istante e torna indietro. Se il browser segnala entrambe le transizioni, la console mostra `hidden` e poi `visible`, e il paragrafo torna a mostrare `visible`. Ricarica la scheda per ripristinare l’esempio. Per verificare il gestore in Node.js, salva il codice come `main.js` ed esegui `node main.js`: un documento di prova simula entrambe le transizioni.

Lezioni correlate

  • JavaScript · Lezione 13 · Avanzato · Versione: 4

Fonti