React
import { StickySidebar, useStickySidebar } from 'dynamic-sticky-sidebar/react';
به React نسخهی 16.8 یا جدیدتر نیاز دارد. نقطهی ورود با "use client" علامتگذاری شده، پس بدون هیچ تغییری در App Router نسخهی Next.js کار میکند.
کامپوننت <StickySidebar>
یک <aside> رندر میکند (با as قابل تغییر است) و رفتار سایدبار را به آن متصل میکند:
import { StickySidebar } from 'dynamic-sticky-sidebar/react';
export function Layout({ children }: { children: React.ReactNode }) {
return (
<div className="layout">
<StickySidebar header=".site-header" gap={16} media="(min-width: 768px)" className="sidebar">
<Filters />
</StickySidebar>
<main>{children}</main>
</div>
);
}
- همهی آپشنها را بهصورت prop میپذیرد.
asالمنت رندرشده را تعیین میکند و پیشفرض آن'aside'است.- بقیهی propها (
className،id،aria-*، event handlerها و…) به المنت پاس داده میشوند. refبه المنت DOM فوروارد میشود.
هوک useStickySidebar
یک callback ref برمیگرداند که روی المنت خودتان میگذارید:
import { useRef } from 'react';
import { useStickySidebar } from 'dynamic-sticky-sidebar/react';
export function Page() {
const headerRef = useRef<HTMLElement>(null);
const sidebarRef = useStickySidebar({
header: headerRef,
gap: 16,
media: '(min-width: 768px)',
});
return (
<>
<header ref={headerRef} className="site-header">…</header>
<div className="layout">
<nav ref={sidebarRef}>…</nav>
<main>…</main>
</div>
</>
);
}
نمونه هنگام mount شدن المنت ساخته و هنگام unmount شدن آن destroy میشود.
ref بهعنوان آپشن
header و scroller علاوه بر مقادیر معمول (المنت / selector)، یک RefObject هم میپذیرند. ref در لحظهی اعمال آپشنها خوانده میشود.
آپشنهای reactive
تغییرات header، scroller، media، gap و مقادیر عددی offsetTop / offsetBottom در re-render اعمال میشوند. برای offsetهای وابسته به state، عدد ساده را ترجیح بدهید:
const [bannerOpen, setBannerOpen] = useState(true);
<StickySidebar header=".site-header" offsetTop={bannerOpen ? 48 : 0}>
آپشنهای تابعی (offsetTop، offsetBottom، subscribe) همیشه از آخرین render خوانده میشوند، پس arrow functionهای inline هیچوقت نمونه را از نو راهاندازی نمیکنند. getter در هر محاسبهی دوباره (اسکرول، resize، تغییر هدر) خوانده میشود. تغییر stateی که پشت آن است بهتنهایی محاسبهی دوباره را فعال نمیکند، پس هر جا این موضوع مهم است از عدد یا subscribe استفاده کنید.
هدرهای وابسته به state
اگر offset هدر در یک store نگهداری میشود، آن را با subscribe وصل کنید:
<StickySidebar
header=".site-header"
subscribe={(update) => useHeaderStore.subscribe(update)}
>
subscribe تابع update را دریافت میکند و باید یک تابع unsubscribe برگرداند. این آپشن همیشه از آخرین render خوانده میشود، پس تابع inline در هر render نمونه را از نو راهاندازی نمیکند.
تایپها
import type {
StickySidebarProps,
UseStickySidebarOptions,
StickySidebarOptions,
HeaderInput,
Px,
} from 'dynamic-sticky-sidebar/react';