Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

Eventos DOMContentLoaded, pagehide y scroll

Distingue cuándo está listo el DOM, cuándo se abandona la página y cuándo cambia el desplazamiento. Elige el objeto adecuado y ten en cuenta la caché bfcache.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

document.addEventListener("DOMContentLoaded", onReady, { once: true });
window.addEventListener("pagehide", onPageHide);
document.addEventListener("scroll", onDocumentScroll);
scrollBox.addEventListener("scroll", onElementScroll);

Estos eventos del navegador responden a tres preguntas distintas: ¿está listo el DOM para la inicialización?, ¿está saliendo el navegador de este documento?, ¿ha cambiado la posición de desplazamiento? Son parte de la plataforma web, no de ECMAScript; no des por hecho que un entorno ajeno al navegador dispone de document y window.

DOMContentLoaded se dispara en document cuando termina el análisis del HTML, se han ejecutado los scripts clásicos con defer y el navegador ha iniciado la evaluación de los módulos sin async programados para el final del análisis. El evento no espera a que termine la evaluación asíncrona de los módulos: un await de nivel superior en una dependencia puede retrasar la ejecución del cuerpo del módulo que la importa hasta después del evento. A diferencia de load, no espera a las imágenes, los marcos incrustados ni los scripts async. Una hoja de estilos puede retrasarlo indirectamente si bloquea un script.

Si el código de inicialización puede ejecutarse tarde, consulta document.readyState. Si vale "loading", registra un escuchador de un solo uso para DOMContentLoaded; en caso contrario, inicializa de inmediato. "interactive" significa que el análisis ha terminado, no que el evento ya se haya disparado o que los demás scripts diferidos hayan terminado.

Escucha pagehide en window para reaccionar cuando el navegador abandona el documento, no por un simple cambio de pestaña. En ese PageTransitionEvent, event.persisted === true indica que el documento podría recuperarse de la caché de navegación atrás y adelante (bfcache), sin garantizarlo; false indica que no se conserva para reutilizarlo. Para reanudar el trabajo tras una restauración, usa pageshow con persisted === true, no DOMContentLoaded. pagehide puede no producirse, por ejemplo si el sistema cierra un navegador móvil. Guarda los datos importantes durante el uso; para detectar que una pestaña pasa a estar oculta, usa visibilitychange y comprueba que el estado sea "hidden".

Para el desplazamiento de la página, escucha scroll en document y lee window.scrollY; para un contenedor desplazable, escucha el evento en el propio elemento y lee su scrollTop. El desplazamiento provocado por código también puede disparar el evento, que no indica el final del desplazamiento. Mantén ligero el manejador, ya que los eventos pueden llegar seguidos; limita la frecuencia de las actualizaciones costosas si hace falta.

Ejemplos

(() => {
  const viewportHeight = 80;
  const contentHeight = 240;

  function run(page, doc, createScrollBox) {
    page.addEventListener("pagehide", (event) => {
      console.log(`pagehide: persisted=${event.persisted}`);
    });

    function init() {
      console.log("DOM ready");

      const box = createScrollBox();
      box.addEventListener("scroll", () => {
        console.log(`scroll: ${box.scrollTop}`);
      }, { once: true });

      box.scrollTop = 40;
    }

    if (doc.readyState === "loading") {
      doc.addEventListener("DOMContentLoaded", init, { once: true });
    } else {
      init();
    }
  }

  if (typeof window !== "undefined" && typeof document !== "undefined") {
    run(window, document, () => {
      const box = document.createElement("div");
      box.style.cssText = `width: 200px; height: ${viewportHeight}px; overflow: auto`;

      const content = document.createElement("div");
      content.style.height = `${contentHeight}px`;
      content.textContent = "Scroll demo";
      box.append(content);
      document.body.append(box);
      return box;
    });
    return;
  }

  // Node.js stand-ins exercise the same listeners without a browser DOM.
  class ScrollBox extends EventTarget {
    #offset = 0;

    get scrollTop() {
      return this.#offset;
    }

    set scrollTop(value) {
      const offset = Math.min(Math.max(0, value), contentHeight - viewportHeight);
      if (offset === this.#offset) return;
      this.#offset = offset;
      setTimeout(() => this.dispatchEvent(new Event("scroll")), 0);
    }
  }

  const page = new EventTarget();
  const doc = new EventTarget();
  doc.readyState = "loading";
  run(page, doc, () => new ScrollBox());
  doc.readyState = "interactive";
  doc.dispatchEvent(new Event("DOMContentLoaded"));
})();

Resultado

DOM ready
scroll: 40

Ejecuta el código una vez en la consola de una página HTML vacía ya cargada. La inicialización es inmediata y el código desplaza el contenedor. Activa la conservación del registro y navega a otro documento en la misma pestaña para buscar una línea adicional `pagehide: persisted=true` o `pagehide: persisted=false`. Esa línea no está garantizada. En Node.js, unos objetos sustitutos basados en `EventTarget` ejecutan los mismos manejadores de disponibilidad del DOM y desplazamiento, sin comprobar el comportamiento real del navegador.

Lecciones relacionadas

  • JavaScript · Lección 45 · Avanzado · Versión: 4

Fuentes