Peristiwa untuk CSS position:sticky

TL;DR (Ringkasan)

Berikut rahasianya: Anda mungkin tidak memerlukan peristiwa scroll di aplikasi berikutnya. Dengan IntersectionObserver, saya akan menunjukkan cara mengaktifkan peristiwa kustom saat elemen position:sticky diperbaiki atau saat elemen tersebut berhenti melekat. Semua dilakukan tanpa menggunakan pemroses scroll. Bahkan ada demo keren untuk membuktikannya:

Lihat demo | Sumber

Memperkenalkan acara sticky-change

Salah satu batasan praktis dalam menggunakan posisi melekat CSS adalah bahwa posisi tersebut tidak memberikan sinyal platform untuk mengetahui kapan properti aktif. Dengan kata lain, tidak ada peristiwa yang dapat mengetahui kapan suatu elemen menjadi melekat atau kapan elemen tersebut berhenti melekat.

Ambil contoh berikut, yang memperbaiki <div class="sticky"> 10 px dari bagian atas penampung induknya:

.sticky {
  position: sticky;
  top: 10px;
}

Bukankah lebih menyenangkan jika browser diberi tahu ketika elemen mencapai tanda itu? Tampaknya saya bukan satu-satunya yang berpikir seperti itu. Sinyal untuk position:sticky dapat membuka sejumlah kasus penggunaan:

  1. Terapkan drop shadow ke banner selagi menempel.
  2. Saat pengguna membaca konten Anda, catat hit analisis untuk mengetahui progresnya.
  3. Saat pengguna men-scroll halaman, perbarui widget TOC mengambang ke bagian saat ini.

Dengan mempertimbangkan kasus penggunaan ini, kita telah membuat sasaran akhir: membuat peristiwa yang aktif saat elemen position:sticky menjadi tetap. Sebut saja peristiwa sticky-change:

document.addEventListener('sticky-change', e => {
  const header = e.detail.target;  // header became sticky or stopped sticking.
  const sticking = e.detail.stuck; // true when header is sticky.
  header.classList.toggle('shadow', sticking); // add drop shadow when sticking.

  document.querySelector('.who-is-sticking').textContent = header.textContent;
});

Demo akan menggunakan peristiwa ini untuk header drop shadow ketika menjadi tetap. Hal ini juga memperbarui judul baru di bagian atas halaman.

Dalam demo, efek diterapkan tanpa peristiwa scroll.

Scroll efek tanpa peristiwa scroll?

Struktur halaman.
Struktur halaman.

Mari kita singkirkan beberapa terminologi sehingga saya dapat merujuk ke nama-nama ini di seluruh postingan:

  1. Penampung scroll - area konten (area tampilan yang terlihat) yang berisi daftar "postingan blog".
  2. Header - judul biru di setiap bagian yang memiliki position:sticky.
  3. Bagian melekat - setiap bagian konten. Teks yang bergulir di bawah {i>header<i} yang melekat.
  4. "Mode lekat" - saat position:sticky diterapkan ke elemen.

Untuk mengetahui header mana yang memasuki "mode lekat", kita memerlukan cara untuk menentukan offset scroll penampung scroll. Dengan begitu, kita akan tahu cara menghitung header yang sedang ditampilkan. Namun, cara ini cukup rumit untuk dilakukan tanpa peristiwa scroll :) Masalah lainnya adalah position:sticky menghapus elemen dari tata letak saat elemen tersebut diperbaiki.

Jadi, tanpa peristiwa scroll, kita kehilangan kemampuan untuk melakukan penghitungan terkait tata letak di header.

Menambahkan DOM dumby untuk menentukan posisi scroll

Sebagai ganti peristiwa scroll, kita akan menggunakan IntersectionObserver untuk menentukan kapan headers masuk dan keluar dari mode lekat. Menambahkan dua node (disebut juga sentinel) di setiap bagian melekat, satu di atas dan satu di bawah, akan berfungsi sebagai titik jalan untuk mencari tahu posisi scroll. Saat penanda ini masuk dan keluar dari penampung, visibilitasnya berubah dan Intersection Observer akan mengaktifkan callback.

Tanpa elemen sentinel yang ditampilkan
Elemen sentinel yang tersembunyi.

Kita memerlukan dua sentinel untuk mencakup empat kasus scroll ke atas dan ke bawah:

  1. Men-scroll ke bawah - header menjadi melekat saat sentinel atasnya menyilang bagian atas penampung.
  2. Men-scroll ke bawah - header keluar dari mode lekat saat mencapai bagian bawah bagian dan sentinel bawahnya bersilangan di bagian atas penampung.
  3. Men-scroll ke atas - header keluar dari mode lekat saat sentinel atasnya di-scroll kembali ke tampilan dari atas.
  4. Men-scroll ke atas - header menjadi melekat saat sentinel bawahnya bersilang kembali agar terlihat dari atas.

Anda dapat melihat screencast 1-4 secara berurutan:

Intersection Observer mengaktifkan callback saat penjaga masuk/meninggalkan container scroll.

CSS

Penjaga ditempatkan di bagian atas dan bawah setiap bagian. .sticky_sentinel--top berada di atas header, sedangkan .sticky_sentinel--bottom terletak di bagian bawah bagian:

Sentinel bawah mencapai ambang batasnya.
Posisi elemen sentinel atas dan bawah.
:root {
  --default-padding: 16px;
  --header-height: 80px;
}
.sticky {
  position: sticky;
  top: 10px; /* adjust sentinel height/positioning based on this position. */
  height: var(--header-height);
  padding: 0 var(--default-padding);
}
.sticky_sentinel {
  position: absolute;
  left: 0;
  right: 0; /* needs dimensions */
  visibility: hidden;
}
.sticky_sentinel--top {
  /* Adjust the height and top values based on your on your sticky top position.
  e.g. make the height bigger and adjust the top so observeHeaders()'s
  IntersectionObserver fires as soon as the bottom of the sentinel crosses the
  top of the intersection container. */
  height: 40px;
  top: -24px;
}
.sticky_sentinel--bottom {
  /* Height should match the top of the header when it's at the bottom of the
  intersection container. */
  height: calc(var(--header-height) + var(--default-padding));
  bottom: 0;
}

Menyiapkan Pengamat Persimpangan

Intersection Observer secara asinkron mengamati perubahan pada perpotongan elemen target dan area pandang dokumen atau penampung induk. Dalam kasus ini, kita mengamati persimpangan dengan container induk.

Saus ajaibnya adalah IntersectionObserver. Setiap sentinel mendapatkan IntersectionObserver untuk mengamati visibilitas persimpangannya dalam container scroll. Saat sentinel men-scroll ke area pandang yang terlihat, kita akan tahu bahwa header menjadi tetap atau tidak lagi melekat. Demikian pula, ketika sentinel keluar dari area pandang.

Pertama, saya menyiapkan observer untuk sentinel {i>header<i} dan {i>footer<i}:

/**
 * Notifies when elements w/ the `sticky` class begin to stick or stop sticking.
 * Note: the elements should be children of `container`.
 * @param {!Element} container
 */
function observeStickyHeaderChanges(container) {
  observeHeaders(container);
  observeFooters(container);
}

observeStickyHeaderChanges(document.querySelector('#scroll-container'));

Kemudian, saya menambahkan observer untuk diaktifkan saat elemen .sticky_sentinel--top melewati bagian atas container scroll (ke kedua arah). Fungsi observeHeaders membuat penjaga teratas dan menambahkannya ke setiap bagian. Observer menghitung perpotongan sentinel dengan bagian atas container dan memutuskan apakah sentinel masuk atau keluar dari area tampilan. Informasi tersebut menentukan apakah header bagian melekat atau tidak.

/**
 * Sets up an intersection observer to notify when elements with the class
 * `.sticky_sentinel--top` become visible/invisible at the top of the container.
 * @param {!Element} container
 */
function observeHeaders(container) {
  const observer = new IntersectionObserver((records, observer) => {
    for (const record of records) {
      const targetInfo = record.boundingClientRect;
      const stickyTarget = record.target.parentElement.querySelector('.sticky');
      const rootBoundsInfo = record.rootBounds;

      // Started sticking.
      if (targetInfo.bottom < rootBoundsInfo.top) {
        fireEvent(true, stickyTarget);
      }

      // Stopped sticking.
      if (targetInfo.bottom >= rootBoundsInfo.top &&
          targetInfo.bottom < rootBoundsInfo.bottom) {
       fireEvent(false, stickyTarget);
      }
    }
  }, {threshold: [0], root: container});

  // Add the top sentinels to each section and attach an observer.
  const sentinels = addSentinels(container, 'sticky_sentinel--top');
  sentinels.forEach(el => observer.observe(el));
}

Observer dikonfigurasi dengan threshold: [0] sehingga callback-nya diaktifkan segera setelah sentinel terlihat.

Prosesnya serupa untuk sentinel bawah (.sticky_sentinel--bottom). Observer kedua dibuat untuk diaktifkan saat footer melewati bagian bawah penampung scroll. Fungsi observeFooters membuat node sentinel dan melampirkannya ke setiap bagian. Observer menghitung persimpangan sentinel dengan bagian bawah container dan memutuskan apakah sentinel masuk atau keluar. Informasi tersebut menentukan apakah header bagian melekat atau tidak.

/**
 * Sets up an intersection observer to notify when elements with the class
 * `.sticky_sentinel--bottom` become visible/invisible at the bottom of the
 * container.
 * @param {!Element} container
 */
function observeFooters(container) {
  const observer = new IntersectionObserver((records, observer) => {
    for (const record of records) {
      const targetInfo = record.boundingClientRect;
      const stickyTarget = record.target.parentElement.querySelector('.sticky');
      const rootBoundsInfo = record.rootBounds;
      const ratio = record.intersectionRatio;

      // Started sticking.
      if (targetInfo.bottom > rootBoundsInfo.top && ratio === 1) {
        fireEvent(true, stickyTarget);
      }

      // Stopped sticking.
      if (targetInfo.top < rootBoundsInfo.top &&
          targetInfo.bottom < rootBoundsInfo.bottom) {
        fireEvent(false, stickyTarget);
      }
    }
  }, {threshold: [1], root: container});

  // Add the bottom sentinels to each section and attach an observer.
  const sentinels = addSentinels(container, 'sticky_sentinel--bottom');
  sentinels.forEach(el => observer.observe(el));
}

Observer dikonfigurasi dengan threshold: [1] sehingga callback-nya diaktifkan saat seluruh node berada dalam tampilan.

Terakhir, ada dua utilitas saya untuk mengaktifkan peristiwa kustom sticky-change dan menghasilkan sentinel:

/**
 * @param {!Element} container
 * @param {string} className
 */
function addSentinels(container, className) {
  return Array.from(container.querySelectorAll('.sticky')).map(el => {
    const sentinel = document.createElement('div');
    sentinel.classList.add('sticky_sentinel', className);
    return el.parentElement.appendChild(sentinel);
  });
}

/**
 * Dispatches the `sticky-event` custom event on the target element.
 * @param {boolean} stuck True if `target` is sticky.
 * @param {!Element} target Element to fire the event on.
 */
function fireEvent(stuck, target) {
  const e = new CustomEvent('sticky-change', {detail: {stuck, target}});
  document.dispatchEvent(e);
}

Selesai.

Demo terakhir

Kita membuat peristiwa kustom saat elemen dengan position:sticky menjadi tetap dan menambahkan efek scroll tanpa menggunakan peristiwa scroll.

Lihat demo | Sumber

Kesimpulan

Saya sering bertanya-tanya apakah IntersectionObserver akan menjadi alat yang berguna untuk menggantikan beberapa pola UI berbasis peristiwa scroll yang telah berkembang selama bertahun-tahun. Ternyata jawabannya ya dan tidak. Semantik API IntersectionObserver membuatnya sulit digunakan untuk semuanya. Namun, seperti yang saya tunjukkan di sini, Anda dapat menggunakannya untuk beberapa teknik menarik.

Cara lain untuk mendeteksi perubahan gaya?

Tidak juga. Yang kita butuhkan adalah cara untuk mengamati perubahan gaya pada elemen DOM. Sayangnya, tidak ada apa pun di API platform web yang memungkinkan Anda melihat perubahan gaya.

MutationObserver akan menjadi pilihan pertama yang logis, tetapi tidak berfungsi untuk sebagian besar kasus. Misalnya, dalam demo, kita akan menerima callback saat class sticky ditambahkan ke elemen, tetapi tidak saat gaya terkomputasi elemen berubah. Ingat kembali bahwa class sticky sudah dideklarasikan saat pemuatan halaman.

Di masa mendatang, ekstensi "Style Mutation Observer" ke Mutation Observer mungkin berguna untuk mengamati perubahan pada gaya komputasi elemen. position: sticky.