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

CKTIS / JavaScript

Eventos `scroll` y `resize` y la opción `passive`

Elige el objeto adecuado para escuchar el desplazamiento o el cambio de tamaño, y distingue cuándo `passive` impide cancelar la acción predeterminada.

Versión: Current web platform; runtime support varies

Sintaxis

// ECMAScript 2024 identifies the JavaScript language reference, not the version of these browser APIs.
// The DOM Standard defines the passive listener option, CSSOM View defines scroll and resize,
// and the Resize Observer specification defines ResizeObserver.
document.addEventListener("scroll", onPageScroll);
scrollContainer.addEventListener("scroll", onElementScroll);
window.addEventListener("resize", onViewportResize);
scrollContainer.addEventListener("wheel", onWheel, { passive: true });
scrollContainer.removeEventListener("wheel", onWheel);

const observer = new ResizeObserver(onElementResize);
observer.observe(element);
// When observation is no longer needed:
observer.disconnect();

Escucha scroll en document para detectar el desplazamiento de la página o directamente en el elemento que se desplaza para seguir los cambios dentro de un contenedor. scroll informa de un cambio de posición, ya lo provoque el usuario o el código. wheel informa de una entrada que no siempre provoca desplazamiento. Escucha resize en window cuando cambie el tamaño del área visible de la página; este evento no se propaga en la fase de burbujeo. Usa ResizeObserver para observar el tamaño de un elemento.

Pasa { passive: true } en el objeto de opciones como tercer argumento de addEventListener(); un booleano por sí solo en esa posición establece capture, no passive. En un listener pasivo, preventDefault() no tiene efecto y puede generar un aviso. { passive: false } permite cancelar la acción predeterminada solo si event.cancelable es true. Los eventos scroll del documento o de un elemento y los eventos resize de la ventana que genera el navegador no se pueden cancelar; esta opción no cambia ese comportamiento.

Con entradas como wheel o touchmove, un listener pasivo permite al navegador iniciar el desplazamiento sin esperar a que ese listener termine. Si omites la opción, su valor predeterminado puede depender del evento, del objeto que lo recibe y del navegador. Usa passive: true si solo observas la entrada. Si necesitas cancelar la acción, indica passive: false y comprueba event.cancelable.

passive no reduce la frecuencia de las llamadas ni el coste del trabajo que realizan. Mantén breves los manejadores de eventos frecuentes y, si necesitas espaciar el trabajo costoso, limita su frecuencia con un temporizador. requestAnimationFrame() ayuda a sincronizar las actualizaciones visuales con los fotogramas, pero por sí solo no garantiza una frecuencia menor que la de scroll.

Para limpiar, llama a removeEventListener() en el mismo objeto con el mismo tipo, la misma función y el mismo valor de capture; passive no interviene en la coincidencia. Estas API pertenecen a la plataforma web, no a ECMAScript 2024. Comprueba la compatibilidad en el entorno de ejecución de destino.

Ejemplos

{
  const cases = [
    ["scroll", false, false],
    ["resize", false, false],
    ["wheel", true, true],
    ["wheel", true, false],
  ];

  for (const [type, cancelable, passive] of cases) {
    const target = new EventTarget();
    target.addEventListener(type, (event) => event.preventDefault(), { passive });
    const event = new Event(type, { cancelable });
    target.dispatchEvent(event);
    console.log(`${type} cancelable=${event.cancelable} passive=${passive} defaultPrevented=${event.defaultPrevented}`);
  }
}

Resultado

scroll cancelable=false passive=false defaultPrevented=false
resize cancelable=false passive=false defaultPrevented=false
wheel cancelable=true passive=true defaultPrevented=false
wheel cancelable=true passive=false defaultPrevented=true

Ejecuta el código en la consola de un navegador. Los eventos sintéticos no desplazan la página ni cambian el tamaño de la ventana. Solo el último caso pone `defaultPrevented` en `true`: el evento se puede cancelar y el listener no es pasivo. El intento de cancelación en el listener pasivo puede generar un aviso aparte.

Lecciones relacionadas

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

Fuentes