База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / JavaScript

Събитията DOMContentLoaded, pagehide и scroll

Разграничи готовността на DOM, напускането на страницата и превъртането. Избери правилния обект за слушателя и отчети възможното възстановяване от bfcache.

Версия: ECMAScript 2024 and the current web platform; runtime support varies

Синтаксис

document.addEventListener("DOMContentLoaded", onReady, { once: true });
window.addEventListener("pagehide", onPageHide);
document.addEventListener("scroll", onDocumentScroll);
scrollBox.addEventListener("scroll", onElementScroll);

Тези събития на браузъра отговарят на три различни въпроса: готов ли е DOM за инициализация, напуска ли браузърът документа и променила ли се е позицията на превъртане? Те са част от уеб платформата, а не от ECMAScript. Не приемай, че извън браузъра са налични document и window.

DOMContentLoaded се задейства върху document, след като анализът на HTML приключи, класическите скриптове с defer се изпълнят и браузърът започне оценяването на модулните скриптове без async, предвидени за края на анализа. Събитието не изчаква края на асинхронното оценяване на модулите: await на най-горно ниво в модул, от който има зависимост, може да отложи изпълнението на тялото на импортиращия модул до момент след събитието. За разлика от load, събитието не изчаква изображения, вградени рамки или скриптове с async. Таблица със стилове може да го забави косвено, ако блокира скрипт.

Ако кодът за инициализация може да се изпълни късно, провери document.readyState. При стойност "loading" регистрирай еднократен слушател за DOMContentLoaded; в противен случай инициализирай веднага. "interactive" означава, че анализът е приключил, но не и че събитието вече е настъпило или че другите отложени скриптове са приключили.

Слушай за pagehide върху window, за да реагираш при напускане на документа, а не при обикновена смяна на раздела. При това събитие от тип PageTransitionEvent стойността event.persisted === true означава, че документът може да бъде възстановен от кеша за навигация назад и напред (bfcache), но това не е гарантирано; false означава, че документът не се запазва за повторна употреба. За да продължиш работа след възстановяване, използвай pageshow с persisted === true, а не DOMContentLoaded. pagehide може да не настъпи, например ако системата прекрати мобилния браузър. Запазвай важните данни в хода на работа; за да установиш, че разделът е скрит, използвай visibilitychange и провери за състояние "hidden".

За превъртане на страницата слушай за scroll върху document и чети window.scrollY; за контейнер с превъртане слушай върху самия елемент и чети неговото scrollTop. Превъртане, предизвикано от код, също може да задейства събитието, което не отбелязва края на превъртането. Нека обработката е лека, защото събитията могат да идват бързо едно след друго; при нужда ограничи честотата на ресурсоемките обновявания.

Примери

(() => {
  const viewportHeight = 80;
  const contentHeight = 240;

  function run(page, doc, createScrollBox) {
    page.addEventListener("pagehide", (event) => {
      console.log(`pagehide: persisted=${event.persisted}`);
    });

    function init() {
      console.log("DOM ready");

      const box = createScrollBox();
      box.addEventListener("scroll", () => {
        console.log(`scroll: ${box.scrollTop}`);
      }, { once: true });

      box.scrollTop = 40;
    }

    if (doc.readyState === "loading") {
      doc.addEventListener("DOMContentLoaded", init, { once: true });
    } else {
      init();
    }
  }

  if (typeof window !== "undefined" && typeof document !== "undefined") {
    run(window, document, () => {
      const box = document.createElement("div");
      box.style.cssText = `width: 200px; height: ${viewportHeight}px; overflow: auto`;

      const content = document.createElement("div");
      content.style.height = `${contentHeight}px`;
      content.textContent = "Scroll demo";
      box.append(content);
      document.body.append(box);
      return box;
    });
    return;
  }

  // Node.js stand-ins exercise the same listeners without a browser DOM.
  class ScrollBox extends EventTarget {
    #offset = 0;

    get scrollTop() {
      return this.#offset;
    }

    set scrollTop(value) {
      const offset = Math.min(Math.max(0, value), contentHeight - viewportHeight);
      if (offset === this.#offset) return;
      this.#offset = offset;
      setTimeout(() => this.dispatchEvent(new Event("scroll")), 0);
    }
  }

  const page = new EventTarget();
  const doc = new EventTarget();
  doc.readyState = "loading";
  run(page, doc, () => new ScrollBox());
  doc.readyState = "interactive";
  doc.dispatchEvent(new Event("DOMContentLoaded"));
})();

Резултат

DOM ready
scroll: 40

Изпълни кода веднъж в конзолата на заредена празна HTML страница. Инициализацията става веднага, а кодът превърта съдържанието на контейнера. Включи запазването на журнала и отвори друг документ в същия раздел. Провери дали се появява допълнителен ред `pagehide: persisted=true` или `pagehide: persisted=false`. Този ред не е гарантиран. В Node.js заместващи обекти, базирани на `EventTarget`, извикват същите обработчици за готовност на DOM и превъртане, без да проверяват действителното поведение на браузъра.

Свързани уроци

  • JavaScript · Урок 45 · Напреднало · Версия: 4

Източници