dynamic-sticky-sidebardynamic-sticky-sidebar
راهنما
  • Vanilla JS
  • React
  • Vue
API
دمو
npm
  • English
  • فارسی
  • العربية
  • Deutsch
  • Français
  • Italiano
GitHub
راهنما
  • Vanilla JS
  • React
  • Vue
API
دمو
npm
  • English
  • فارسی
  • العربية
  • Deutsch
  • Français
  • Italiano
GitHub
  • راهنما

    • مقدمه
    • شروع به کار
    • الزامات چیدمان
    • هدرهای پویا
    • چطور کار می‌کند
    • عیب‌یابی
  • فریم‌ورک‌ها

    • Vanilla JS
    • React
    • Vue
  • مرجع

    • مرجع API
    • دموی زنده

چطور کار می‌کند

بیشتر اسکریپت‌های سایدبار چسبان، سایدبار را در هر رویداد scroll با transform یا top جابه‌جا می‌کنند. چون رویداد scroll بعد از اینکه مرورگر اسکرول را انجام داده می‌رسد، سایدبار همیشه یک فریم عقب است و می‌لرزد. این کتابخانه برعکس عمل می‌کند: کار هر فریم را position: sticky خود مرورگر انجام می‌دهد و JS فقط قوانین را تغییر می‌دهد.

دو موقعیت چسبیده

کتابخانه در هر به‌روزرسانی دو موقعیت برای لبه‌ی بالای سایدبار، نسبت به viewport (یا اسکرولر)، محاسبه می‌کند:

max = header bottom + offsetTop + gap        // pinned under the header
min = viewport height − sidebar height − offsetBottom − gap   // bottom aligned

اگر سایدبار جا شود (max − min < 1px)، فقط در top: max می‌چسبد و اتفاق دیگری نمی‌افتد.

چهار حالت

وقتی سایدبار از فضای موجود بلندتر باشد، بین چهار حالت جابه‌جا می‌شود:

  1. TOPچسبیده زیر هدرtop: max
  2. DOWNاسکرول ↓، همراه صفحه حرکت می‌کندtop: auto + margin-top
  3. BOTTOMلبه‌ی پایین چسبیدهtop: min
  4. UPاسکرول ↑، همراه صفحه حرکت می‌کندbottom + margin-bottom
حالتقید stickyچیزی که می‌بینید
TOPtop: maxچسبیده زیر هدر
DOWNtop: auto + فاصله‌ی margin-topهمراه صفحه اسکرول می‌شود، در مسیر پایین
BOTTOMtop: minلبه‌ی پایین به پایین viewport چسبیده
UPbottom: … + فاصله‌ی margin-bottomهمراه صفحه اسکرول می‌شود، در مسیر بالا

جابه‌جایی بین حالت‌ها فقط وقتی اتفاق می‌افتد که جهت اسکرول عوض شود یا سایدبار به یکی از لبه‌ها برسد. اسکرول به پایین آن را از TOP، از طریق DOWN، به BOTTOM می‌برد. اسکرول به بالا آن را از BOTTOM، از طریق UP، به TOP برمی‌گرداند.

اگر وسط راه جهت عوض شود (DOWN ↔ UP)، سایدبار دوباره از همان جایی که هست آزاد می‌شود، پس هیچ‌وقت پرش نمی‌کند.

وقتی سایدبار «آزاد» است (DOWN / UP)، کتابخانه top/bottom را روی auto می‌گذارد و یک margin به اندازه‌ی فاصله‌ی فعلی سایدبار از موقعیت طبیعی‌اش اضافه می‌کند. سایدبار دقیقاً همان جایی از صفحه که بود می‌ماند و از آن به بعد به‌صورت بومی همراه صفحه اسکرول می‌شود. وقتی به لبه‌ی دیگر برسد، دوباره موقعیت‌دهی sticky مرورگر کنترل را به دست می‌گیرد و کتابخانه فقط حالت جدید را ثبت می‌کند.

چرا grid یا flex

برای اینکه سایدبار رو به بالا آزاد شود، باید به پایین ظرفش لنگر شده باشد. در والد grid یا row-flex، کتابخانه align-self: flex-end را به‌همراه یک margin پایین تنظیم می‌کند و سایدبار به‌صورت بومی به بالا اسکرول می‌شود.

در جریان block هیچ راهی برای تراز کردن یک آیتم به پایین وجود ندارد، پس کتابخانه هنگام اسکرول به بالا به محاسبه‌ی top با JS برمی‌گردد. الزامات چیدمان را ببینید.

دنبال کردن هدر

وقتی هدر جابه‌جا می‌شود، max تغییر می‌کند. در حالت TOP، کتابخانه بلافاصله top جدید را می‌نویسد، پس سایدبار همراه هدر حرکت می‌کند.

چون انیمیشن هدر می‌تواند بدون هیچ اسکرولی اجرا شود، کتابخانه هر وقت احتمال حرکت چیزی باشد یک حلقه‌ی کوتاه requestAnimationFrame راه می‌اندازد:

  • یک scroll، resize یا callback از ResizeObserver؛
  • یک رویداد transitionrun / animationstart یا یک mutation در attributeهای هدر.

این حلقه تا وقتی max در حال تغییر است یا یک انیمیشن متناهی روی هدر اجرا می‌شود، در هر فریم دوباره محاسبه می‌کند و 3 فریم بی‌کاری بعد از ثابت شدن همه‌چیز خودش متوقف می‌شود. وقتی صفحه بی‌کار است، هیچ چیزی اجرا نمی‌شود.

جزئیات کوچک

  • فقط تغییرات واقعی نوشته می‌شوند. top و bottom قبل از دست زدن به DOM با آخرین مقدار نوشته‌شده مقایسه می‌شوند و مقادیر تا 0.01px گرد می‌شوند.
  • scroll anchoring روی سایدبار غیرفعال است (overflow-anchor: none) تا مرورگر با تنظیم‌های margin درگیر نشود.
  • تغییر اندازه‌ی سایدبار (بارگذاری محتوا، باز شدن آکاردئون‌ها) با ResizeObserver تشخیص داده می‌شود. سایدبار آزاد، در همان موقعیت فعلی‌اش روی صفحه دوباره لنگر می‌شود.
  • فقط listenerهای passive. listener اسکرول passive است و فقط یک فریم زمان‌بندی می‌کند.
ویرایش این صفحه در GitHub
قبلی
هدرهای پویا
بعدی
عیب‌یابی