---
title: Sheet
description: A flyout that opens from the side of the screen, based on the dialog component.

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 shadcn@latest add @coss/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,
  SheetContent,
  SheetDescription,
  SheetFooter,
  SheetHeader,
  SheetPanel,
  SheetPopup,
  SheetTitle,
  SheetTrigger,
} from "@/components/ui/sheet"
```

```tsx
<Sheet>
  <SheetTrigger>Open</SheetTrigger>
  <SheetPopup>
    <SheetHeader>
      <SheetTitle>Are you absolutely sure?</SheetTitle>
      <SheetDescription>
        This action cannot be undone. This will permanently delete your account
        and remove your data from our servers.
      </SheetDescription>
    </SheetHeader>
    <SheetPanel>Content</SheetPanel>
    <SheetFooter>
      <SheetClose>Close</SheetClose>
    </SheetFooter>
  </SheetPopup>
</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.

### SheetPopup

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

| Prop              | Type                                      | Default     | Description                                      |
| ----------------- | ----------------------------------------- | ----------- | ------------------------------------------------ |
| `side`            | `"right" \| "left" \| "top" \| "bottom"`  | `"right"`   | Controls which side of the screen the sheet opens from |
| `variant`         | `"default" \| "inset"`                    | `"default"` | Controls the sheet style. `inset` adds spacing around the sheet on desktop screens |
| `showCloseButton` | `boolean`                                 | `true`      | When true, displays a close button in the top-right corner |
| `closeProps`      | `Dialog.Close.Props`                      | -           | Props forwarded to the internal close button, useful for overriding `aria-label` |
| `portalProps`     | `Dialog.Portal.Props`                     | -           | Props forwarded to the internal portal (`keepMounted`, `container`, etc.); see Base UI Dialog portal API |

**Example:**

```tsx
// Right side sheet (default)
<SheetPopup side="right">
  ...
</SheetPopup>

// Left side sheet
<SheetPopup side="left">
  ...
</SheetPopup>

// Top sheet
<SheetPopup side="top">
  ...
</SheetPopup>

// Bottom sheet
<SheetPopup side="bottom">
  ...
</SheetPopup>

// Sheet with inset variant
<SheetPopup side="right" variant="inset">
  ...
</SheetPopup>
```

### SheetHeader

Container for the sheet title and description. Supports the `render` prop for polymorphic composition (e.g. `render={<Link href="/" />}`).

### SheetFooter

Footer section for action buttons. Supports the `render` prop for polymorphic composition.

| Prop        | Type                     | Default     | Description                                      |
| ----------- | ------------------------ | ----------- | ------------------------------------------------ |
| `variant`   | `"default" \| "bare"`    | `"default"` | Controls the footer styling. `default` includes border and background, `bare` removes them |

### SheetTitle

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

### SheetDescription

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

### SheetPanel

Scrollable content container. Automatically wraps content in a `ScrollArea` component. Supports the `render` prop for polymorphic composition.

| Prop         | Type      | Default | Description                                      |
| ------------ | --------- | ------- | ------------------------------------------------ |
| `scrollFade` | `boolean` | `true`  | When true, shows a fade effect at scroll edges   |

**Example:**

```tsx
<SheetPanel>
  {/* Long content that will scroll if it exceeds the sheet height */}
  <div>...</div>
</SheetPanel>
```

### 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

### Sheet with Inset

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

### Side sheets

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