mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-23 20:55:47 +00:00
104 lines
2.1 KiB
Plaintext
104 lines
2.1 KiB
Plaintext
---
|
|
title: Sheet
|
|
description: Extends the Dialog component to display content that complements the main content of the screen.
|
|
component: true
|
|
links:
|
|
doc: https://www.radix-ui.com/docs/primitives/components/dialog
|
|
api: https://www.radix-ui.com/docs/primitives/components/dialog#api-reference
|
|
---
|
|
|
|
<ComponentPreview name="sheet-demo" description="A sheet component." />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">CLI</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add sheet
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps>
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install @radix-ui/react-dialog
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource name="sheet" />
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
### Usage
|
|
|
|
```tsx
|
|
import {
|
|
Sheet,
|
|
SheetContent,
|
|
SheetDescription,
|
|
SheetHeader,
|
|
SheetTitle,
|
|
SheetTrigger,
|
|
} from "@/components/ui/sheet"
|
|
```
|
|
|
|
```tsx
|
|
<Sheet>
|
|
<SheetTrigger>Open</SheetTrigger>
|
|
<SheetContent>
|
|
<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>
|
|
</SheetContent>
|
|
</Sheet>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Side
|
|
|
|
Use the `side` property to `<SheetContent />` to indicate the edge of the screen where the component will appear. The values can be `top`, `right`, `bottom` or `left`.
|
|
|
|
<ComponentPreview name="sheet-side" />
|
|
|
|
### Size
|
|
|
|
You can adjust the size of the sheet using CSS classes:
|
|
|
|
```tsx {3}
|
|
<Sheet>
|
|
<SheetTrigger>Open</SheetTrigger>
|
|
<SheetContent className="w-[400px] sm:w-[540px]">
|
|
<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>
|
|
</SheetContent>
|
|
</Sheet>
|
|
```
|