Drawer

پنلی که از لبهٔ صفحه بالا می‌آید و با کشیدن بسته می‌شود؛ حس اپلیکیشن بومی موبایل را می‌دهد. برای صفحه‌های کوچک جایگزین دیالوگ است و برای دسکتاپ معمولاً دیالوگ یا کشو (Sheet) مناسب‌تر است.

ری‌اکت ۱۹ و Next.js با پیاده‌سازی دسترس‌پذیری داخلی دیگویو ۳ با Composition API و Reka UISvelte ۵ با runes و Bits UIانگولار با signals و Angular CDK

این کامپوننت فعلاً برای ۱ فریم‌ورک از ۴ فریم‌ورک آماده است.

این نمونه هنوز برای Vue پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

این نمونه هنوز برای Svelte پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

این نمونه هنوز برای Angular پورت نشده است؛ آنچه می‌بینید نسخهٔ ری‌اکت است.

نصب

با CLI اختصاصی dig-ui کامپوننت را از رجیستری دیگ نصب کنید؛ وابستگی‌ها و فایل‌ها خودکار اضافه می‌شوند.

نصب سریع با لینک سخت و دیسک مشترکپکیج‌منیجر پیش‌فرض Node.jsYarn نسخهٔ ۲ به بالا (Berry)رانتایم و پکیج‌منیجر Bun
pnpm dlx dig-ui@latest add https://design-system-tau-green.vercel.app/r/drawer.json
npx dig-ui@latest add https://design-system-tau-green.vercel.app/r/drawer.json
yarn dlx dig-ui@latest add https://design-system-tau-green.vercel.app/r/drawer.json
bunx --bun dig-ui@latest add https://design-system-tau-green.vercel.app/r/drawer.json

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Reka UI در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Bits UI در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Angular CDK در دست کار است.

استفاده

import {
  Drawer,
  DrawerClose,
  DrawerContent,
  DrawerDescription,
  DrawerFooter,
  DrawerHeader,
  DrawerTitle,
  DrawerTrigger,
} from "@/components/ui/drawer"

<Drawer>
  <DrawerTrigger asChild>
    <Button>باز کردن</Button>
  </DrawerTrigger>
  <DrawerContent>
    <DrawerHeader>
      <DrawerTitle>عنوان</DrawerTitle>
      <DrawerDescription>توضیح</DrawerDescription>
    </DrawerHeader>
  </DrawerContent>
</Drawer>

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Reka UI در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Bits UI در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Angular CDK در دست کار است.

ترکیب اجزا

روی هستهٔ Dialog خودِ دیگ ساخته شده، نه vaul؛ نسخهٔ فعلی کشیدن با انگشت را نمی‌فهمد، فقط با دکمه، کلیک بیرون یا Escape بسته می‌شود. جهت با direction تعیین می‌شود و مقدارهایش فیزیکی‌اند (top/bottom/left/right)؛ در چیدمان راست‌به‌چپ برای کشوی کناری معمولاً left همان لبهٔ پایانی است. دستگیرهٔ کشیدن فقط روی کشوی پایین نشان داده می‌شود چون فقط همان‌جا معنا دارد (خودِ کشیدن فعلاً تعاملی نیست). عرض محتوا را با یک div داخلی (mx-auto max-w-sm) کنترل کنید تا روی دسکتاپ کش نیاید.

دسترس‌پذیری

  • فوکوس هنگام باز شدن داخل کشو قفل می‌شود و با بسته شدن به تریگر برمی‌گردد.
  • DrawerTitle الزامی است؛ بدون آن صفحه‌خوان نمی‌داند این پنل چیست. اگر عنوان دیداری نمی‌خواهید، با کلاس sr-only پنهانش کنید.
  • Escape و کلیک بیرون کشو را می‌بندند؛ برای فرم‌های حساس با dismissible={false} جلوی بسته شدن ناخواسته را بگیرید.
  • پس‌زمینه هنگام باز بودن کشو قفل اسکرول می‌شود تا محتوای زیرین جابه‌جا نشود.
  • روی دسکتاپ به‌جای کشو از دیالوگ استفاده کنید.

مرجع API

Drawer

ویژگینوعپیش‌فرضتوضیح
open / onOpenChangeboolean / (open: boolean) => voidمدیریت کنترل‌شدهٔ باز و بسته بودن.
direction"top" | "bottom" | "left" | "right""bottom"لبه‌ای که کشو از آن می‌آید؛ مقدارها فیزیکی‌اند نه منطقی.
dismissiblebooleantrueبا false کلیک بیرون و Escape کشو را نمی‌بندد؛ فقط دکمه‌ها.

DrawerContent

ویژگینوعپیش‌فرضتوضیح
childrenReact.ReactNodeعرض را با یک div داخلی (mx-auto max-w-sm) محدود کنید تا روی دسکتاپ کش نیاید.
classNamestringکلاس‌های پایه بر اساس prop مقدار direction انتخاب می‌شوند؛ کلاس شما روی همان‌ها می‌نشیند.

DrawerHeader / DrawerFooter / DrawerClose

ویژگینوعپیش‌فرضتوضیح
DrawerTitleComponentالزامی برای دسترس‌پذیری؛ در صورت نیاز با sr-only پنهانش کنید.
DrawerDescriptionComponentتوضیح کوتاه زیر عنوان؛ به aria-describedby وصل می‌شود.
DrawerCloseComponentهر عنصری را با asChild به دکمهٔ بستن تبدیل می‌کند.

این کامپوننت هنوز برای Vue پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Reka UI در دست کار است.

این کامپوننت هنوز برای Svelte پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Bits UI در دست کار است.

این کامپوننت هنوز برای Angular پورت نشده است.

نسخهٔ ری‌اکت آماده است؛ پورت این فریم‌ورک روی Angular CDK در دست کار است.