Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Události wheel, pagehide, pageshow a beforeunload

Rozlište gesto kolečkem či touchpadem od posunu obsahu, rozpoznejte obnovení stránky z mezipaměti historie a varujte před ztrátou neuložených změn.

Verze: ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

element.addEventListener("wheel", onWheel, { passive: true });
window.addEventListener("pagehide", onPageHide);
window.addEventListener("pageshow", onPageShow);
window.addEventListener("beforeunload", onBeforeUnload);
window.removeEventListener("beforeunload", onBeforeUnload);

Tyto události patří do API prohlížeče, ne do ECMAScriptu 2024. Událost wheel poslouchejte na prvku, události pagehide, pageshow a beforeunload na window. Detaily chování se mezi prohlížeči liší.

wheel (WheelEvent) hlásí gesto kolečkem myši nebo touchpadem, nikoli skutečný posun obsahu: gesto může změnit přiblížení nebo nepohnout ničím, zatímco posouvat lze i klávesnicí. deltaX a deltaY popisují gesto; deltaMode určuje jednotku: 0 pro pixely, 1 pro řádky a 2 pro stránky. Skutečný posun zjistíte porovnáním hodnot scrollLeft a scrollTop v posluchači scroll. Pro pouhé sledování použijte { passive: true }. Pokud potřebujete zabránit výchozímu posunu či přiblížení, použijte { passive: false } a volejte preventDefault() pouze tehdy, když event.cancelable je true. Některé prohlížeče umožňují zrušit jen první událost v sérii.

pagehide a pageshow mají typ PageTransitionEvent. Při opuštění stránky pagehide s persisted: true znamená, že stránka může zůstat v mezipaměti pro navigaci zpět a vpřed (bfcache), nikoli že bude později určitě obnovena. pageshow s persisted: true znamená, že tatáž stránka byla z bfcache obnovena; při prvním načtení následuje pageshow po load a má persisted: false. Ani jedna událost nesleduje běžné přepínání karet a pageshow nedokazuje, že je stránka viditelná. preventDefault() tyto přechody nezastaví.

beforeunload (BeforeUnloadEvent) může nastat před zavřením, opětovným načtením nebo opuštěním stránky. Voláním preventDefault() požádejte o potvrzovací dialog; kvůli starším prohlížečům nastavte také event.returnValue na neprázdný řetězec. Vrácení neprázdného řetězce z obslužné funkce je starší mechanismus pro onbeforeunload, ne pro addEventListener(). Dialog vyžaduje předchozí interakci uživatele (trvalou aktivaci), jeho zobrazení není zaručeno a text určuje prohlížeč.

Posluchač beforeunload přidávejte jen při neuložených změnách a po jejich uložení nebo zahození jej odeberte. Ani pagehide, ani beforeunload nejsou spolehlivé, zvláště na mobilních zařízeních. Ukládejte průběžně a použijte visibilitychange na document při document.visibilityState === "hidden" jako další podnět k uložení, ne jako důkaz ukončení relace.

Příklady

(() => {
  const element = typeof document === "undefined"
    ? new EventTarget()
    : document.createElement("div");
  const page = new EventTarget();

  element.addEventListener("wheel", (event) => {
    const unit = event.deltaMode;
    if (event.cancelable) event.preventDefault();
    console.log(`wheel: deltaY=${event.deltaY}, deltaMode=${unit}, canceled=${event.defaultPrevented}`);
  }, { passive: false });

  const logTransition = (event) => {
    console.log(`${event.type}: persisted=${event.persisted}`);
  };
  page.addEventListener("pagehide", logTransition);
  page.addEventListener("pageshow", logTransition);
  page.addEventListener("beforeunload", (event) => event.preventDefault());

  const wheel = typeof WheelEvent === "function"
    ? new WheelEvent("wheel", {
        deltaY: 3, deltaMode: WheelEvent.DOM_DELTA_LINE, cancelable: true
      })
    : Object.assign(new Event("wheel", { cancelable: true }), {
        deltaY: 3, deltaMode: 1 // Lines, as with WheelEvent.DOM_DELTA_LINE.
      });
  const transition = (type) => typeof PageTransitionEvent === "function"
    ? new PageTransitionEvent(type, { persisted: true })
    : Object.assign(new Event(type), { persisted: true });

  element.dispatchEvent(wheel);
  page.dispatchEvent(transition("pagehide"));
  page.dispatchEvent(transition("pageshow"));
  const result = page.dispatchEvent(new Event("beforeunload", { cancelable: true }));
  console.log(`beforeunload: dispatchEvent returned ${result}`);
})();

Výsledek

wheel: deltaY=3, deltaMode=1, canceled=true
pagehide: persisted=true
pageshow: persisted=true
beforeunload: dispatchEvent returned false

Spusťte kód v konzoli prohlížeče nebo v Node.js 24. V prohlížeči míří syntetická událost `wheel` na prvek nepřipojený k dokumentu. V Node.js prvek nahrazuje `EventTarget` a vlastnosti událostí `wheel`, `pagehide` a `pageshow` se přidávají k běžným objektům `Event`. V obou prostředích zastupuje `window` samostatný `EventTarget`. `false` znamená zrušení testovací události, ne zastavení navigace. Kód neposouvá stránku, neobnovuje ji z bfcache ani neotevírá dialog.

Související lekce

  • JavaScript · Lekce 36 · Pokročilá · Verze: 4

Zdroje