116 lines
2.3 KiB
Plaintext
116 lines
2.3 KiB
Plaintext
---
|
|
title: Sheet
|
|
description: Extends the Dialog component to display content that complements the main content of the screen.
|
|
base: aria
|
|
component: true
|
|
links:
|
|
doc: https://react-aria.adobe.com/Modal
|
|
api: https://react-aria.adobe.com/Modal#api
|
|
---
|
|
|
|
<ComponentPreview styleName="aria-nova" name="sheet-demo" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add sheet
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install react-aria-components
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="sheet"
|
|
title="components/ui/sheet.tsx"
|
|
styleName="aria-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
Sheet,
|
|
SheetClose,
|
|
SheetDescription,
|
|
SheetFooter,
|
|
SheetHeader,
|
|
SheetTitle,
|
|
SheetTrigger,
|
|
} from "@/components/ui/sheet"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<SheetTrigger>
|
|
<Button>Open</Button>
|
|
<Sheet>
|
|
<SheetHeader>
|
|
<SheetTitle>Are you absolutely sure?</SheetTitle>
|
|
<SheetDescription>This action cannot be undone.</SheetDescription>
|
|
</SheetHeader>
|
|
</Sheet>
|
|
</SheetTrigger>
|
|
```
|
|
|
|
## Composition
|
|
|
|
Use the following composition to build a `Sheet`:
|
|
|
|
```text
|
|
SheetTrigger
|
|
├── Button
|
|
└── Sheet
|
|
├── SheetHeader
|
|
│ ├── SheetTitle
|
|
│ └── SheetDescription
|
|
└── SheetFooter
|
|
```
|
|
|
|
## Side
|
|
|
|
Use the `side` prop on `SheetContent` to set the edge of the screen where the sheet appears. Values are `top`, `right`, `bottom`, or `left`.
|
|
|
|
<ComponentPreview styleName="aria-nova" name="sheet-side" />
|
|
|
|
## No Close Button
|
|
|
|
Use `showCloseButton={false}` on `SheetContent` to hide the close button.
|
|
|
|
<ComponentPreview styleName="aria-nova" name="sheet-no-close-button" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="aria-nova" name="sheet-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [React Aria Modal](https://react-aria.adobe.com/Modal#api) documentation.
|