---
title: Sheet
description: A side panel that slides in from the edge of the screen.

links:
  doc: https://base-ui.com/react/components/dialog#api-reference
---

<ComponentPreview name="p-sheet-1" />

## Installation

<CodeTabs>

<TabsList>
  <TabsTab value="cli">CLI</TabsTab>
  <TabsTab value="manual">Manual</TabsTab>
</TabsList>

<TabsPanel value="cli">

```bash
npx @olyx/cli@latest add sheet
```

</TabsPanel>

<TabsPanel value="manual">

<Steps>

<Step>Install the following dependencies:</Step>

```bash
npm install @base-ui/react
```

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="sheet" title="components/ui/sheet.tsx" />

<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsPanel>

</CodeTabs>

## Usage

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

```tsx
<Sheet>
  <SheetTrigger>Open</SheetTrigger>
  <SheetContent>
    <SheetHeader>
      <SheetTitle>Edit Profile</SheetTitle>
      <SheetDescription>
        Make changes to your profile here. Click save when you're done.
      </SheetDescription>
    </SheetHeader>
    <SheetPanel>Content goes here</SheetPanel>
    <SheetFooter>
      <SheetClose>Cancel</SheetClose>
      <Button>Save</Button>
    </SheetFooter>
  </SheetContent>
</Sheet>
```

## API Reference

### Sheet

Root component. Alias for `Dialog.Root` from Base UI.

### SheetTrigger

Trigger button that opens the sheet. Alias for `Dialog.Trigger` from Base UI.

### SheetContent

Popup container that displays the sheet content. Also exported as `SheetPopup`.

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

### SheetHeader

Container for the sheet title and description.

### SheetFooter

Footer section for action buttons.

| Prop      | Type                  | Default     |
| --------- | --------------------- | ----------- |
| `variant` | `"default" \| "bare"` | `"default"` |

### SheetTitle

Title component. Alias for `Dialog.Title` from Base UI.

### SheetDescription

Description component. Alias for `Dialog.Description` from Base UI.

### SheetPanel

Scrollable content container.

### SheetClose

Close button component. Alias for `Dialog.Close` from Base UI.

### SheetPortal

Portal component for rendering outside the DOM hierarchy. Alias for `Dialog.Portal` from Base UI.

### SheetBackdrop

Backdrop/overlay component. Also exported as `SheetOverlay`. Alias for `Dialog.Backdrop` from Base UI.

## Examples

### Inset Variant

<ComponentPreview name="p-sheet-2" />

### Side Positions

<ComponentPreview name="p-sheet-3" />