پرش به محتوا

کشو

یک صفحهٔ مبتنی بر ژست که از هر لبه‌ای به داخل می‌لغزد برای منوهای موبایل، فیلترها و فرم‌های سریع — با حاشیه‌ها و سایه‌های نئوبروتالیست.

"use client"

import * as React from "react"

Drawer پنلی است که از لبهٔ صفحه می‌لغزد و می‌توان با drag بستش. بر پایهٔ Vaul از Emil Kowalski ساخته شده و با دستور پخت نئوبروتالیستی استایل شده: حاشیه‌های ضخیم، سایه‌های سخت و تایپوگرافی پررنگ.

برای این موارد از آن استفاده کنید:

  • Action sheet موبایل — منوی اشتراک، گزینه‌های sort، تأیید سریع. ژست drag-to-dismiss بهتر از شکار دکمهٔ بستن ریز روی لمس است.
  • پنل فیلتر و تنظیمات — فیلتر فروشگاه یا ترجیحات که از popover جا بیشتر می‌خواهند ولی صفحهٔ جدا نمی‌طلبند.
  • دیالوگ واکنش‌گرا — با Dialog جفتش کنید تا روی دسکتاپ مدال و روی موبایل drawer رندر شود (نمونهٔ پایین را ببینید).

درباره

Drawer بر پایهٔ Vaul ساختهٔ emilkowalski ساخته شده است.

نصب

pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/drawer.json
npx shadcn@latest add https://neobrutalism.com/r/base/drawer.json
yarn dlx shadcn@latest add https://neobrutalism.com/r/base/drawer.json
bunx --bun shadcn@latest add https://neobrutalism.com/r/base/drawer.json

وابستگی‌های زیر را نصب کنید:

pnpm add vaul
npm install vaul
yarn add vaul
bun add vaul

کد زیر را کپی کرده و در پروژهٔ خود جای‌گذاری کنید.

components/ui/drawer.tsx
"use client"

import * as React from "react"
import { Drawer as DrawerPrimitive } from "vaul"

import { cn } from "@/lib/utils"

function Drawer({
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Root>) {
  return <DrawerPrimitive.Root data-slot="drawer" {...props} />
}

function DrawerTrigger({
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Trigger>) {
  return <DrawerPrimitive.Trigger data-slot="drawer-trigger" {...props} />
}

function DrawerPortal({
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Portal>) {
  return <DrawerPrimitive.Portal data-slot="drawer-portal" {...props} />
}

function DrawerClose({
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Close>) {
  return <DrawerPrimitive.Close data-slot="drawer-close" {...props} />
}

function DrawerOverlay({
  className,
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Overlay>) {
  return (
    <DrawerPrimitive.Overlay
      data-slot="drawer-overlay"
      className={cn(
        "fixed inset-0 z-50 bg-foreground/20 supports-backdrop-filter:backdrop-blur-xs data-open:animate-in data-open:fade-in-0 data-closed:animate-out data-closed:fade-out-0",
        className
      )}
      {...props}
    />
  )
}

function DrawerContent({
  className,
  children,
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Content>) {
  return (
    <DrawerPortal data-slot="drawer-portal">
      <DrawerOverlay />
      <DrawerPrimitive.Content
        data-slot="drawer-content"
        className={cn(
          "group/drawer-content fixed z-50 flex h-auto flex-col bg-popover text-sm text-popover-foreground shadow-md data-[vaul-drawer-direction=bottom]:inset-x-0 data-[vaul-drawer-direction=bottom]:bottom-0 data-[vaul-drawer-direction=bottom]:mt-24 data-[vaul-drawer-direction=bottom]:max-h-[80vh] data-[vaul-drawer-direction=bottom]:rounded-t-xl data-[vaul-drawer-direction=bottom]:border-t-2 data-[vaul-drawer-direction=left]:inset-y-0 data-[vaul-drawer-direction=left]:left-0 data-[vaul-drawer-direction=left]:w-3/4 data-[vaul-drawer-direction=left]:rounded-r-xl data-[vaul-drawer-direction=left]:border-r-2 data-[vaul-drawer-direction=right]:inset-y-0 data-[vaul-drawer-direction=right]:right-0 data-[vaul-drawer-direction=right]:w-3/4 data-[vaul-drawer-direction=right]:rounded-l-xl data-[vaul-drawer-direction=right]:border-l-2 data-[vaul-drawer-direction=top]:inset-x-0 data-[vaul-drawer-direction=top]:top-0 data-[vaul-drawer-direction=top]:mb-24 data-[vaul-drawer-direction=top]:max-h-[80vh] data-[vaul-drawer-direction=top]:rounded-b-xl data-[vaul-drawer-direction=top]:border-b-2 data-[vaul-drawer-direction=left]:sm:max-w-sm data-[vaul-drawer-direction=right]:sm:max-w-sm",
          className
        )}
        {...props}
      >
        <div className="mx-auto mt-4 hidden h-1 w-[100px] shrink-0 rounded-full bg-muted group-data-[vaul-drawer-direction=bottom]/drawer-content:block" />
        {children}
      </DrawerPrimitive.Content>
    </DrawerPortal>
  )
}

function DrawerHeader({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="drawer-header"
      className={cn(
        "flex flex-col gap-0.5 p-4 group-data-[vaul-drawer-direction=bottom]/drawer-content:text-center group-data-[vaul-drawer-direction=top]/drawer-content:text-center md:gap-0.5 md:text-left",
        className
      )}
      {...props}
    />
  )
}

function DrawerFooter({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="drawer-footer"
      className={cn("mt-auto flex flex-col gap-2 p-4", className)}
      {...props}
    />
  )
}

function DrawerTitle({
  className,
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Title>) {
  return (
    <DrawerPrimitive.Title
      data-slot="drawer-title"
      className={cn(
        "font-head text-base font-medium text-foreground",
        className
      )}
      {...props}
    />
  )
}

function DrawerDescription({
  className,
  ...props
}: React.ComponentProps<typeof DrawerPrimitive.Description>) {
  return (
    <DrawerPrimitive.Description
      data-slot="drawer-description"
      className={cn("text-sm text-muted-foreground", className)}
      {...props}
    />
  )
}

export {
  Drawer,
  DrawerPortal,
  DrawerOverlay,
  DrawerTrigger,
  DrawerClose,
  DrawerContent,
  DrawerHeader,
  DrawerFooter,
  DrawerTitle,
  DrawerDescription,
}

مسیرهای import را مطابق با پیکربندی پروژهٔ خود به‌روزرسانی کنید.

استفاده

import {
  Drawer,
  DrawerClose,
  DrawerContent,
  DrawerDescription,
  DrawerFooter,
  DrawerHeader,
  DrawerTitle,
  DrawerTrigger,
} from "@/components/ui/drawer"
<Drawer>
  <DrawerTrigger>Open</DrawerTrigger>
  <DrawerContent>
    <DrawerHeader>
      <DrawerTitle>Are you absolutely sure?</DrawerTitle>
      <DrawerDescription>This action cannot be undone.</DrawerDescription>
    </DrawerHeader>
    <DrawerFooter>
      <Button>Submit</Button>
      <DrawerClose>
        <Button variant="outline">Cancel</Button>
      </DrawerClose>
    </DrawerFooter>
  </DrawerContent>
</Drawer>

ترکیب

برای ساخت یک Drawer از ترکیب زیر استفاده کنید:

Drawer
├── DrawerTrigger
└── DrawerContent
    ├── DrawerHeader
    │   ├── DrawerTitle
    │   └── DrawerDescription
    └── DrawerFooter

نمونه‌ها

محتوای قابل اسکرول

هنگام اسکرول محتوا، اقدامات را قابل‌مشاهده نگه دارید.

import { Button } from "@/components/ui/button"
import {
  Drawer,

جهت‌ها

برای تنظیم جهت drawer از prop direction استفاده کنید. گزینه‌های موجود عبارت‌اند از top، right، bottom و left.

import { Button } from "@/components/ui/button"
import {
  Drawer,

Dialog واکنش‌گرا

می‌توانید کامپوننت‌های Dialog و Drawer را ترکیب کنید تا یک dialog واکنش‌گرا بسازید. این کار یک کامپوننت Dialog را روی دسکتاپ و یک Drawer را روی موبایل رندر می‌کند.

"use client"

import * as React from "react"

RTL

برای فعال‌سازی پشتیبانی RTL در Neobrutalism، راهنمای پیکربندی RTL را ببینید.

"use client"

import * as React from "react"

دسترسی‌پذیری

Drawer از الگوی WAI-ARIA Dialog (Modal) پیروی می‌کند: Vaul روی primitiveِ Radix Dialog ساخته شده، پس پنل با role="dialog" و aria-modal رندر می‌شود، فوکوس را حین باز بودن گیر می‌اندازد، و با DrawerTitle برچسب و با DrawerDescription توصیف می‌شود. بستن با drag فقط اشاره‌گر است — کاربران صفحه‌کلید با Escape یا دکمهٔ DrawerClose می‌بندند؛ پس همیشه یکی بگذارید.

تعاملات صفحه‌کلید:

کلیدعمل
Space / Enterباز کردن drawer از تریگر فوکوس‌شده
Tab / Shift + Tabچرخاندن فوکوس در محتوای drawer (فوکوس گیر است)
Escapeبستن drawer و بازگرداندن فوکوس به تریگر

مرجع API

برای مرجع کامل API، مستندات Vaul را ببینید.