Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

Zdarzenia `scroll` i `resize` oraz opcja `passive`

Dobierz cel nasłuchiwania do przewijania lub zmiany rozmiaru i ustal, kiedy opcja `passive` wpływa na możliwość anulowania domyślnej akcji.

Wersja: Current web platform; runtime support varies

Składnia

// 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();

Nasłuchuj scroll na document, gdy przewijana jest strona, albo bezpośrednio na przewijanym elemencie, gdy zmienia się pozycja przewijania w kontenerze. scroll informuje o zmianie pozycji, niezależnie od tego, czy spowodował ją użytkownik, czy kod. wheel opisuje wejście z urządzenia i nie musi powodować przewijania. Nasłuchuj resize na window, gdy zmienia się rozmiar obszaru widoku; to zdarzenie nie propaguje się w fazie bąbelkowania. Do obserwowania rozmiaru elementu użyj ResizeObserver.

Opcję { passive: true } przekaż w obiekcie opcji jako trzeci argument addEventListener(); wartość logiczna w tym miejscu ustawia capture, nie passive. W pasywnym nasłuchiwaczu preventDefault() nie ma skutku i może wywołać ostrzeżenie. { passive: false } pozwala anulować domyślną akcję tylko wtedy, gdy event.cancelable jest prawdziwe. Zdarzeń scroll dokumentu lub elementu ani resize okna generowanych przez przeglądarkę nie można anulować; ta opcja tego nie zmienia.

Przy wejściu takim jak wheel lub touchmove pasywny nasłuchiwacz pozwala przeglądarce rozpocząć przewijanie bez czekania na zakończenie jego działania. Domyślna wartość po pominięciu opcji może zależeć od zdarzenia, celu i przeglądarki. Ustaw passive: true, gdy tylko obserwujesz wejście. Jeśli musisz anulować akcję, ustaw passive: false i sprawdź event.cancelable.

passive nie ogranicza częstotliwości wywołań ani nie zmniejsza kosztu obsługi. Utrzymuj krótką obsługę częstych zdarzeń; jeśli kosztowna praca musi odbywać się rzadziej, ogranicz jej częstotliwość za pomocą timera. requestAnimationFrame() pomaga zgrać aktualizacje wizualne z klatkami, ale sam nie gwarantuje rzadszych wywołań niż scroll.

Przy sprzątaniu wywołaj removeEventListener() na tym samym celu, z tym samym typem, tą samą funkcją i wartością capture; passive nie bierze udziału w dopasowaniu. Te API należą do platformy WWW, nie do ECMAScript 2024. Sprawdź obsługę w docelowym środowisku.

Przykłady

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

Wynik

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

Uruchom kod w konsoli przeglądarki. Zdarzenia syntetyczne nie przewijają strony ani nie zmieniają rozmiaru okna. Tylko ostatni przypadek ustawia `defaultPrevented` na `true`: zdarzenie można anulować, a nasłuchiwacz nie jest pasywny. Pasywna próba anulowania może wywołać osobne ostrzeżenie.

Powiązane lekcje

  • JavaScript · Lekcja 11 · Zaawansowany · Wersja: 4

Źródła