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

CKTIS / JavaScript

Eventos de `Window`: `popstate` y `hashchange`

Usa `popstate` para leer el estado de la entrada del historial activada y `hashchange` para detectar un cambio del fragmento de la URL en el mismo documento.

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

Sintaxis

window.addEventListener("popstate", handlePopState); // PopStateEvent: event.state
window.addEventListener("hashchange", handleHashChange); // HashChangeEvent: event.oldURL, event.newURL

// Alternative: assign one handler per property.
window.onpopstate = handlePopState;
window.onhashchange = handleHashChange;

popstate y hashchange son dos eventos distintos de Window, definidos por la plataforma web, no por ECMAScript. Escúchalos con window.addEventListener(). También puedes usar window.onpopstate y window.onhashchange: al asignar un nuevo manejador a una propiedad, sustituyes el anterior asignado a esa propiedad.

popstate indica que se ha activado otra entrada del historial de sesión, por ejemplo al retroceder o avanzar dentro del mismo documento. PopStateEvent.state contiene el valor restaurado de la entrada de destino, o null si no se guardó ningún estado. La navegación a un fragmento del mismo documento también puede disparar popstate. No dependas de él para inicializar la vista: es posible que el navegador no lo dispare hasta que el usuario interactúe con la página.

hashchange indica un cambio del fragmento de la URL en el mismo documento, por ejemplo al seguir un enlace a #details o asignar un fragmento nuevo a location.hash. HashChangeEvent.oldURL y HashChangeEvent.newURL son URL completas, no solo fragmentos. Si una misma operación dispara ambos eventos, popstate se produce primero.

history.pushState() añade una entrada y history.replaceState() actualiza la entrada actual. Ninguna de las dos llamadas dispara por sí sola ninguno de estos eventos, aunque cambie el fragmento. Renderiza la vista inicial y actualízala directamente después de que tu código modifique correctamente el historial. Si escuchas ambos eventos, evita aplicar la misma actualización dos veces.

Ejemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>History events demo</title>
</head>
<body>
  <button id="run-history-demo" type="button">Run history demo</button>
  <script>
    (() => {
      const button = document.getElementById("run-history-demo");
      button.addEventListener("click", () => {
        button.remove();

        window.addEventListener("popstate", (event) => {
          console.log(`popstate: ${JSON.stringify(event.state)}`);
        }, { once: true });

        window.addEventListener("hashchange", (event) => {
          const from = new URL(event.oldURL).hash;
          const to = new URL(event.newURL).hash;
          console.log(`hashchange: ${from} -> ${to}`);
        }, { once: true });

        history.replaceState({ view: "overview" }, "", "#overview");
        history.pushState({ view: "details" }, "", "#details");
        console.log(`after writes: ${location.hash}`);
        history.back();
      }, { once: true });
    })();
  </script>
</body>
</html>

Resultado

after writes: #details
popstate: {"view":"overview"}
hashchange: #details -> #overview

Guarda el ejemplo como `index.html`, sírvelo mediante HTTP(S) y ábrelo en una pestaña de prueba: el ejemplo modifica entradas del historial. Abre la consola de desarrollo y haz clic en «Run history demo» en la página. Las dos escrituras en el historial no disparan ninguno de los eventos; al volver de forma asíncrona, la consola muestra el estado `overview` y el cambio de fragmento.

Lecciones relacionadas

  • JavaScript · Lección 36 · Intermedio · Versión: 3
  • JavaScript · Lección 37 · Intermedio · Versión: 3

Fuentes