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

شروع به کار

نصب

npm
npm i dynamic-sticky-sidebar
pnpm
pnpm add dynamic-sticky-sidebar
yarn
yarn add dynamic-sticky-sidebar
CDN
<script src="https://unpkg.com/dynamic-sticky-sidebar"></script>
<!-- exposes window.StickySidebar.stickySidebar -->

1. چیدمان صفحه

سایدبار را کنار محتوا داخل یک grid (یا flex با جهت row) بگذارید و جلوی کش آمدنش تا ارتفاع کامل ردیف را بگیرید:

<header class="site-header">…</header>

<div class="layout">
    <aside id="sidebar">…</aside>
    <main>…</main>
</div>
.site-header {
    position: sticky;
    top: 0;
    z-index: 10;
}

.layout {
    display: grid;
    grid-template-columns: 280px 1fr;
    gap: 32px;
    align-items: start; /* important: the sidebar keeps its own height */
}

چرا grid؟

والد grid یا row-flex به کتابخانه اجازه می‌دهد در هر دو جهت از رفتار sticky بومی مرورگر استفاده کند. چیدمان block هم کار می‌کند، اما اسکرول به بالا در آن از یک راه‌حل جایگزین JS استفاده می‌کند. الزامات چیدمان را ببینید.

2. اتصال سایدبار

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

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

// later, e.g. when the page unmounts
sidebar.destroy();
React
import { StickySidebar } from 'dynamic-sticky-sidebar/react';

export function Layout({ children }) {
    return (
        <div className="layout">
            <StickySidebar header=".site-header" gap={16} media="(min-width: 768px)">
                …
            </StickySidebar>
            <main>{children}</main>
        </div>
    );
}
Vue
<script setup>
import { vStickySidebar } from 'dynamic-sticky-sidebar/vue';

const sticky = { header: '.site-header', gap: 16, media: '(min-width: 768px)' };
</script>

<template>
    <div class="layout">
        <aside v-sticky-sidebar="sticky">…</aside>
        <main><slot /></main>
    </div>
</template>

همین. به پایین اسکرول کنید؛ سایدبار تا انتهای خودش همراه محتوا می‌آید و بعد می‌چسبد. به بالا اسکرول کنید؛ برمی‌گردد و زیر هدر می‌چسبد، هر جا که هدر در آن لحظه باشد.

3. امتحانش کنید

داخل کادر زیر اسکرول کنید. منوی فرعی هنگام اسکرول به پایین کنار می‌رود و هنگام اسکرول به بالا برمی‌گردد، و سایدبار هم دنبالش می‌کند.

باز کردن در تب جدید
Shopداخل همین کادر اسکرول کنید ↓
CategoriesBrandsDeals
Filter 1
Filter 2
Filter 3
Filter 4
Filter 5
Filter 6
Filter 7
Filter 8
Filter 9
Filter 10
Filter 11
Filter 12
Filter 13
Filter 14
Filter 15
Filter 16
Filter 17
Filter 18 (last)
Card 1
Card 2
Card 3
Card 4
Card 5
Card 6
Card 7
Card 8
Card 9
Card 10
Card 11
Card 12
Card 13
Card 14
Card 15
Card 16
Card 17
Card 18
Card 19
Card 20
Card 21
Card 22
Card 23
Card 24
footer

قدم‌های بعدی

  • الزامات چیدمان: مقایسه‌ی grid، flex و block، و اشتباه‌های رایج
  • هدرهای پویا: چند هدر، هدرهایی که با JS انیمیت می‌شوند و offsetهای وابسته به state
  • مرجع API: همه‌ی آپشن‌ها و متدهای نمونه
ویرایش این صفحه در GitHub
قبلی
مقدمه
بعدی
الزامات چیدمان