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
    • دموی زنده

مقدمه

dynamic-sticky-sidebar سایدبار را هنگام اسکرول صفحه در دید نگه می‌دارد، حتی وقتی سایدبار از صفحه‌نمایش بلندتر است و هدر بالای آن مدام اندازه‌اش را تغییر می‌دهد.

مشکل چیست

position: sticky; top: 80px ساده خوب کار می‌کند، تا وقتی که یکی از این اتفاق‌ها بیفتد:

  • سایدبار از viewport بلندتر است. بالای آن ثابت می‌ماند و تا انتهای صفحه هیچ راهی برای رسیدن به بخش پایینی‌اش نیست.
  • هدر پنهان و دوباره نمایان می‌شود. خیلی از سایت‌ها هدر (یا ردیف دوم منو) را هنگام اسکرول به پایین کنار می‌زنند و هنگام اسکرول به بالا برمی‌گردانند. یک مقدار ثابت برای top یا فاصله‌ی خالی باقی می‌گذارد یا سایدبار را زیر هدر می‌برد.
  • ارتفاع هدر تغییر می‌کند. بنرها بسته می‌شوند، نوار جست‌وجو باز می‌شود و هدر به حالت فشرده درمی‌آید.

راه‌حل‌های رایج یا به رویداد scroll گوش می‌دهند و در هر فریم transform یا top را تنظیم می‌کنند، که باعث لرزش و تأخیر می‌شود، یا برای هر حالت هدر به offsetهای دستی نیاز دارند.

این کتابخانه چه می‌کند

  • sticky دوطرفه. هنگام اسکرول به پایین، سایدبار بلند همراه محتوا حرکت می‌کند تا پایینش به viewport برسد، بعد می‌چسبد. هنگام اسکرول به بالا، برمی‌گردد تا بالایش به هدر برسد، بعد می‌چسبد. سایدبار کوتاه هم به‌سادگی زیر هدر ثابت می‌ماند.
  • دنبال کردن زنده‌ی هدر. المنت (یا المنت‌های) هدر را پاس می‌دهید و سایدبار زیر پایین‌ترین لبه‌ی قابل‌مشاهده‌ی هدر قرار می‌گیرد. وقتی هدر کنار می‌رود، جمع می‌شود یا تغییر اندازه می‌دهد، سایدبار فریم‌به‌فریم دنبالش می‌کند.
  • اول قابلیت بومی مرورگر. هر فریم اسکرول را position: sticky خود مرورگر مدیریت می‌کند. JS فقط وقتی جهت اسکرول عوض می‌شود یا هدر جابه‌جا می‌شود، قیدهای sticky (top، bottom و یک margin) را تغییر می‌دهد. چطور کار می‌کند را ببینید.

پکیج‌ها

فقط یک پکیج npm با سه نقطه‌ی ورود وجود دارد:

Importکاربرد
dynamic-sticky-sidebarهسته‌ی بدون فریم‌ورک: stickySidebar()
dynamic-sticky-sidebar/reactهوک useStickySidebar و کامپوننت <StickySidebar>
dynamic-sticky-sidebar/vuecomposable، دایرکتیو v-sticky-sidebar و پلاگین

React (نسخه‌ی 16.8 به بالا) و Vue (نسخه‌ی 3.3 به بالا) peer dependencyهای اختیاری هستند. فقط چیزی را نصب کنید که استفاده می‌کنید.

تایپ‌ها همراه پکیج منتشر می‌شوند و هم با moduleResolution: "bundler" / "node16" و هم با تنظیم قدیمی‌تر "node" شناسایی می‌شوند.

حجم باندل

روی بیلد منتشرشده و بعد از minify با NODE_ENV=production اندازه‌گیری شده است، یعنی همان کاری که باندلر شما انجام می‌دهد. نقطه‌های ورود React و Vue هسته را هم شامل می‌شوند.

نقطه‌ی ورودMinifiedgzipbrotli
dynamic-sticky-sidebar3.4 kB1.8 kB1.6 kB
dynamic-sticky-sidebar/react4.6 kB2.2 kB2.0 kB
dynamic-sticky-sidebar/vue4.2 kB2.1 kB1.9 kB
بیلد CDN با <script>3.8 kB2.0 kB1.8 kB
  • بدون وابستگی. React و Vue فقط در نقطه‌ی ورود خودشان استفاده می‌شوند.
  • هشدارهای حالت توسعه در production حذف می‌شوند. پیام‌های کنسول بخش عیب‌یابی داخل process.env.NODE_ENV !== 'production' قرار دارند، پس Vite، webpack، Next.js و Nuxt آن‌ها را از باندل production حذف می‌کنند. بیلد توسعه‌ی هسته حدود 0.2 kB (gzip) بزرگ‌تر است.
  • قابل tree-shake. پکیج با sideEffects: false علامت‌گذاری شده و کامپوننت React به‌عنوان pure مشخص شده است، پس exportهای استفاده‌نشده حذف می‌شوند.

برای بازتولید این اعداد، pnpm size را در مخزن اجرا کنید.

پشتیبانی مرورگرها

هر مرورگری که position: sticky، ResizeObserver و MutationObserver را داشته باشد؛ یعنی همه‌ی مرورگرهای evergreen فعلی. هم بیلدهای ESM/CJS و هم بیلد CDN با <script> روی ES2020 هدف‌گذاری شده‌اند.

ویرایش این صفحه در GitHub
بعدی
شروع به کار