# Sheet

A panel that slides in from any edge, built on the Radix Dialog primitive with overlay, header, footer, title, description, and a corner close button.

- Category: Overlays & Navigation
- License: MIT
- Page: https://www.saasuji.com/components/sheet
- Install: npx shadcn@latest add https://www.saasuji.com/r/sheet.json

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| open (Sheet) | `boolean` | — | Controlled open state of the sheet. |
| defaultOpen (Sheet) | `boolean` | `false` | Open state on first render for an uncontrolled sheet. |
| onOpenChange (Sheet) | `(open: boolean) => void` | — | Called when the open state changes. |
| modal (Sheet) | `boolean` | `true` | Locks page scroll and traps focus while the sheet is open. |
| side (SheetContent) | `"top" | "right" | "bottom" | "left"` | `"right"` | Edge the sheet slides in from, with the matching slide animation. |
| showCloseButton (SheetContent) | `boolean` | `true` | Renders the corner close button inside the panel. |
| asChild (SheetTrigger, SheetClose) | `boolean` | `false` | Renders the trigger or close control as its child element instead of the default button. |
| className (SheetContent, SheetHeader, SheetFooter, SheetTitle, SheetDescription) | `string` | — | Additional classes merged onto the part that receives it. |
| children (all parts) | `React.ReactNode` | — | Trigger label and the header, body, and footer content rendered inside the sliding panel. |
| ...props (Sheet) | `React.ComponentProps<typeof SheetPrimitive.Root>` | — | All remaining Radix Dialog root props are forwarded. |
| ...props (SheetTrigger, SheetClose) | `React.ComponentProps<typeof SheetPrimitive.Trigger> | React.ComponentProps<typeof SheetPrimitive.Close>` | — | All remaining Radix trigger and close props are forwarded to the rendered buttons. |
| ...props (SheetContent) | `React.ComponentProps<typeof SheetPrimitive.Content>` | — | All remaining Radix content props are forwarded (onOpenAutoFocus, forceMount, …). |
| ...props (SheetHeader, SheetFooter) | `React.ComponentProps<"div">` | — | All remaining native div attributes are forwarded. |
| ...props (SheetTitle, SheetDescription) | `React.ComponentProps<typeof SheetPrimitive.Title> | React.ComponentProps<typeof SheetPrimitive.Description>` | — | All remaining Radix title and description props are forwarded. |

## Source

```tsx
"use client"

import * as React from "react"
import XIcon from "lucide-react/dist/esm/icons/x"
import { Dialog as SheetPrimitive } from "radix-ui"

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

function Sheet({ ...props }: React.ComponentProps<typeof SheetPrimitive.Root>) {
  return <SheetPrimitive.Root data-slot="sheet" {...props} />
}

function SheetTrigger({
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Trigger>) {
  return <SheetPrimitive.Trigger data-slot="sheet-trigger" {...props} />
}

function SheetClose({
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Close>) {
  return <SheetPrimitive.Close data-slot="sheet-close" {...props} />
}

function SheetPortal({
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Portal>) {
  return <SheetPrimitive.Portal data-slot="sheet-portal" {...props} />
}

function SheetOverlay({
  className,
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Overlay>) {
  return (
    <SheetPrimitive.Overlay
      data-slot="sheet-overlay"
      className={cn(
        "fixed inset-0 z-[1200] bg-black/50 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:animate-in data-[state=open]:fade-in-0",
        className
      )}
      {...props}
    />
  )
}

function SheetContent({
  className,
  children,
  side = "right",
  showCloseButton = true,
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Content> & {
  side?: "top" | "right" | "bottom" | "left"
  showCloseButton?: boolean
}) {
  return (
    <SheetPortal>
      <SheetOverlay />
      <SheetPrimitive.Content
        data-slot="sheet-content"
        className={cn(
          "fixed z-[1250] flex flex-col gap-4 bg-background shadow-lg transition ease-in-out data-[state=closed]:animate-out data-[state=closed]:duration-300 data-[state=open]:animate-in data-[state=open]:duration-500",
          side === "right" &&
            "inset-y-0 right-0 h-full w-3/4 border-l data-[state=closed]:slide-out-to-right data-[state=open]:slide-in-from-right sm:max-w-sm",
          side === "left" &&
            "inset-y-0 left-0 h-full w-3/4 border-r data-[state=closed]:slide-out-to-left data-[state=open]:slide-in-from-left sm:max-w-sm",
          side === "top" &&
            "inset-x-0 top-0 h-auto border-b data-[state=closed]:slide-out-to-top data-[state=open]:slide-in-from-top",
          side === "bottom" &&
            "inset-x-0 bottom-0 h-auto border-t data-[state=closed]:slide-out-to-bottom data-[state=open]:slide-in-from-bottom",
          className
        )}
        {...props}
      >
        {children}
        {showCloseButton && (
          <SheetPrimitive.Close className="absolute top-4 right-4 rounded-xs opacity-70 ring-offset-background transition-opacity hover:opacity-100 focus:ring-2 focus:ring-ring focus:ring-offset-2 focus:outline-hidden disabled:pointer-events-none data-[state=open]:bg-secondary">
            <XIcon className="size-4" />
            <span className="sr-only">Close</span>
          </SheetPrimitive.Close>
        )}
      </SheetPrimitive.Content>
    </SheetPortal>
  )
}

function SheetHeader({ className, ...props }: React.ComponentProps<"div">) {
  return (
    <div
      data-slot="sheet-header"
      className={cn("flex flex-col gap-1.5 p-4", className)}
      {...props}
    />
  )
}

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

function SheetTitle({
  className,
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Title>) {
  return (
    <SheetPrimitive.Title
      data-slot="sheet-title"
      className={cn("font-semibold text-foreground", className)}
      {...props}
    />
  )
}

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

export {
  Sheet,
  SheetTrigger,
  SheetClose,
  SheetContent,
  SheetHeader,
  SheetFooter,
  SheetTitle,
  SheetDescription,
}

```