dynamic-sticky-sidebardynamic-sticky-sidebar
الدليل
  • JavaScript الخالصة
  • React
  • Vue
API
العرض الحي
npm
  • English
  • فارسی
  • العربية
  • Deutsch
  • Français
  • Italiano
GitHub
الدليل
  • JavaScript الخالصة
  • React
  • Vue
API
العرض الحي
npm
  • English
  • فارسی
  • العربية
  • Deutsch
  • Français
  • Italiano
GitHub
  • الدليل

    • مقدمة
    • البدء
    • متطلبات التخطيط
    • الترويسات الديناميكية
    • كيف تعمل
    • استكشاف الأخطاء وإصلاحها
  • أطر العمل

    • JavaScript الخالصة
    • React
    • Vue
  • المرجع

    • مرجع API
    • العرض الحي

JavaScript الخالصة

import { stickySidebar } from 'dynamic-sticky-sidebar';

الاستخدام الأساسي

const sidebar = stickySidebar('#sidebar', {
    header: '.site-header',
    gap: 16,
    media: '(min-width: 768px)',
});

الوسيط الأول عنصر أو محدِّد (selector). وترمي الدالة خطأً إن لم يطابق شيئًا، لذا أنشئ النسخة بعد أن يصبح العنصر موجودًا.

تُعيد stickySidebar() نسخة:

sidebar.update();          // recalculate now
sidebar.refresh();         // re-query header selectors / scroller and restart
sidebar.setOptions({ … }); // replace options
sidebar.destroy();         // remove listeners and restore inline styles

من دون أداة تجميع

تأتي الحزمة ببناء IIFE يعرّف متغيرًا عامًا باسم StickySidebar:

<script src="https://unpkg.com/dynamic-sticky-sidebar"></script>
<script>
    StickySidebar.stickySidebar('#sidebar', { header: '.site-header' });
</script>

يعمل https://cdn.jsdelivr.net/npm/dynamic-sticky-sidebar أيضًا. ثبّت رقم الإصدار في بيئة الإنتاج، مثل dynamic-sticky-sidebar@0.1.0.

ملف CDN بناء إنتاجي مصغَّر (نحو 2 kB بعد ضغط gzip)، لذا لا يطبع تحذيرات التطوير الموضحة في استكشاف الأخطاء وإصلاحها. إن كنت تريدها، فاستخدم حزمة npm مع أداة تجميع أثناء التطوير.

CommonJS

const { stickySidebar } = require('dynamic-sticky-sidebar');

تحديث الخيارات

تقوم setOptions باستبدال الخيارات ولا تدمجها، لذا مرّر المجموعة كاملة:

const base = { header: '.site-header', media: '(min-width: 768px)' };
const sidebar = stickySidebar('#sidebar', { ...base, gap: 16 });

sidebar.setOptions({ ...base, gap: 24 });

تغيير gap أو offsetTop أو offsetBottom يكتفي بإعادة الحساب. أما تغيير header أو media أو scroller أو subscribe فيعيد تشغيل النسخة.

داخل لوحة قابلة للتمرير

حين لا تُمرَّر الصفحة نفسها بل حاوية بداخلها (هياكل التطبيقات، ولوحات التحكم)، مرّر الحاوية في scroller. وتُقاس المواضع حينها بالنسبة إلى تلك الحاوية:

stickySidebar('#filters', {
    scroller: '#panel',
    header: '#panel-toolbar',
});

التطبيقات أحادية الصفحة

استدعِ destroy() حين يُزال العرض (unmount). فهي تزيل كل مستمع ومراقب وتعيد الأنماط المضمّنة الأصلية للشريط الجانبي. إن كنت تستخدم React أو Vue، فإن المحوّلات تفعل ذلك عنك.

عدّل هذه الصفحة على GitHub
التالي
React