# Sheet

Edge panel from any side of the screen that opens in one frame.

Source: https://www.ui95.dev/ui/sheet

## Examples

```tsx
import { Button } from "@/components/ui/button"
import {
  Sheet,
  SheetClose,
  SheetContent,
  SheetDescription,
  SheetFooter,
  SheetHeader,
  SheetTitle,
  SheetTrigger,
} from "@/components/ui/sheet"

import type { ShowcaseDemo } from "../types"

function renderSide(side: "top" | "right" | "bottom" | "left", showCloseButton = true) {
  return (
    <Sheet>
      <SheetTrigger asChild>
        <Button size="sm" variant={showCloseButton ? "default" : "secondary"} className="self-center">
          {showCloseButton ? side : `${side}, no glyph`}
        </Button>
      </SheetTrigger>
      <SheetContent side={side} showCloseButton={showCloseButton}>
        <SheetHeader>
          <SheetTitle>Properties</SheetTitle>
          <SheetDescription>Opens in one frame from the {side} edge.</SheetDescription>
        </SheetHeader>
        <SheetFooter>
          <SheetClose asChild>
            <Button variant="outline">Close</Button>
          </SheetClose>
        </SheetFooter>
      </SheetContent>
    </Sheet>
  )
}

export const demo: ShowcaseDemo = {
  span: "tall",
  variants: [
    { label: "right", render: () => renderSide("right") },
    { label: "left", render: () => renderSide("left") },
    { label: "top", render: () => renderSide("top") },
    { label: "bottom", render: () => renderSide("bottom") },
    { label: "no close glyph", render: () => renderSide("right", false) },
  ],
}
```

## Installation

```bash
npx shadcn@latest add https://www.ui95.dev/r/sheet.json
```

Run it in a Radix shadcn project that already has the UI95 theme.

Dependencies:

```bash
npm install cn radix-ui
```

Add these items first:

- [button](https://www.ui95.dev/ui/button)
- [pixel-glyphs](https://www.ui95.dev/ui/pixel-glyphs)

`components/ui/sheet.tsx`

```tsx
"use client"

import { cn } from "cn"
import { Dialog as SheetPrimitive } from "radix-ui"
import * as React from "react"

import { Button } from "@/components/ui/button"
import { CloseGlyph } from "@/components/ui/pixel-glyphs"

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 isolate z-50 bg-ink-0 dither-25",
        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"
        data-side={side}
        className={cn(
          "fixed z-50 flex flex-col gap-4 border-border bg-popover text-popover-foreground offset-shadow-3 outline-none data-[side=bottom]:inset-x-0 data-[side=bottom]:bottom-0 data-[side=bottom]:h-auto data-[side=bottom]:border-t-(length:--pixel) data-[side=left]:inset-y-0 data-[side=left]:left-0 data-[side=left]:h-full data-[side=left]:w-3/4 data-[side=left]:border-r-(length:--pixel) data-[side=right]:inset-y-0 data-[side=right]:right-0 data-[side=right]:h-full data-[side=right]:w-3/4 data-[side=right]:border-l-(length:--pixel) data-[side=top]:inset-x-0 data-[side=top]:top-0 data-[side=top]:h-auto data-[side=top]:border-b-(length:--pixel) data-[side=left]:sm:max-w-sm data-[side=right]:sm:max-w-sm",
          className
        )}
        {...props}
      >
        {children}
        {showCloseButton && (
          <SheetPrimitive.Close data-slot="sheet-close" asChild>
            <Button
              variant="ghost"
              className="absolute top-1 right-1 text-titlebar-foreground"
              size="icon-xs"
            >
              <CloseGlyph />
              <span className="sr-only">Close</span>
            </Button>
          </SheetPrimitive.Close>
        )}
      </SheetPrimitive.Content>
    </SheetPortal>
  )
}

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

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

function SheetTitle({
  className,
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Title>) {
  return (
    <SheetPrimitive.Title
      data-slot="sheet-title"
      className={cn(
        "flex h-8 items-center gap-3 border-b-(length:--pixel) border-border bg-titlebar pr-9 pl-3 font-pixel text-[16px] leading-none text-titlebar-foreground uppercase after:h-4 after:min-w-6 after:flex-1 after:stripes after:content-['']",
        className
      )}
      {...props}
    />
  )
}

function SheetDescription({
  className,
  ...props
}: React.ComponentProps<typeof SheetPrimitive.Description>) {
  return (
    <SheetPrimitive.Description
      data-slot="sheet-description"
      className={cn("px-4 text-xl leading-tight text-popover-foreground", className)}
      {...props}
    />
  )
}

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

## API reference

### Sheet

No props of its own. It forwards the props of the element or primitive it wraps.

### SheetClose

No props of its own. It forwards the props of the element or primitive it wraps.

### SheetContent

| Prop | Type | Default |
| --- | --- | --- |
| `side` | `"left" \| "right" \| "top" \| "bottom"` | `"right"` |
| `showCloseButton` | `boolean` | `true` |

### SheetDescription

No props of its own. It forwards the props of the element or primitive it wraps.

### SheetFooter

No props of its own. It forwards the props of the element or primitive it wraps.

### SheetHeader

No props of its own. It forwards the props of the element or primitive it wraps.

### SheetTitle

No props of its own. It forwards the props of the element or primitive it wraps.

### SheetTrigger

No props of its own. It forwards the props of the element or primitive it wraps.

## Used by

- [sidebar](https://www.ui95.dev/ui/sidebar)

## Sounds

- `button.press`
- `button.release`
