CKTIS / JavaScript
Les événements `scroll` et `resize` et l’option `passive`
Choisissez la bonne cible pour le défilement et le redimensionnement, puis repérez quand un écouteur passif empêche l’annulation de l’action par défaut.
Version : Current web platform; runtime support varies
Syntaxe
// 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();Écoutez scroll sur document pour le défilement de la page, ou directement sur l’élément qui défile pour suivre un conteneur. scroll signale un changement de position, qu’il vienne de l’utilisateur ou du code. wheel signale une entrée qui ne provoque pas nécessairement de défilement. Écoutez resize sur window pour suivre la taille de la zone d’affichage ; cet événement ne remonte pas par propagation. Utilisez ResizeObserver pour suivre la taille d’un élément.
Passez { passive: true } dans l’objet d’options en troisième argument de addEventListener() ; un booléen seul à cet emplacement définit capture, pas passive. Dans un écouteur passif, preventDefault() est sans effet et peut produire un avertissement. Avec { passive: false }, l’action par défaut ne peut être annulée que si event.cancelable vaut true. Les événements scroll du document ou d’un élément et resize de la fenêtre générés par le navigateur ne sont pas annulables ; l’option n’y change rien.
Pour une entrée comme wheel ou touchmove, un écouteur passif permet au navigateur de commencer le défilement sans attendre la fin de cet écouteur. Si l’option est omise, sa valeur par défaut peut dépendre de l’événement, de la cible et du navigateur. Définissez passive: true si vous ne faites qu’observer l’entrée. S’il faut annuler l’action, définissez passive: false et vérifiez event.cancelable.
passive ne réduit ni la fréquence des appels ni leur coût. Gardez les gestionnaires d’événements fréquents courts et utilisez un minuteur pour limiter la fréquence des traitements coûteux si nécessaire. requestAnimationFrame() aide à synchroniser les mises à jour visuelles avec les images, mais ne garantit pas à lui seul une fréquence inférieure à celle de scroll.
Pour nettoyer, appelez removeEventListener() sur la même cible avec le même type, la même fonction et la même valeur de capture ; passive ne compte pas dans la correspondance. Ces API relèvent de la plateforme web, pas d’ECMAScript 2024. Vérifiez leur prise en charge dans l’environnement cible.
Exemples
{
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}`);
}
}Résultat
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
Exécutez le code dans la console d’un navigateur. Les événements synthétiques ne font pas défiler la page et ne redimensionnent pas la fenêtre. Seul le dernier cas fait passer `defaultPrevented` à `true` : l’événement est annulable et l’écouteur n’est pas passif. La tentative d’annulation dans l’écouteur passif peut produire un avertissement distinct.
Leçons associées
- JavaScript · Leçon 11 · Avancé · Version : 4
Sources
- Document: scroll event
- Element: scroll event
- Window: resize event
- ResizeObserver
- EventTarget: addEventListener() method
- EventTarget: removeEventListener() method
- Event: preventDefault() method
- Element: wheel event
- Event: Event() constructor
- EventTarget: dispatchEvent() method
- HTML Standard: Processing model
- ECMAScript 2024 Language Specification: Hosts and Implementations