mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-08 22:45:47 +00:00
79 lines
1.9 KiB
Plaintext
79 lines
1.9 KiB
Plaintext
---
|
|
title: Sheet
|
|
description: Extension of Dialog component that displays content that complements the main content of the screen, or a list of actions that affect the main content of the screen.
|
|
component: true
|
|
radix:
|
|
link: https://www.radix-ui.com/docs/primitives/components/dialog
|
|
api: https://www.radix-ui.com/docs/primitives/components/dialog#api-reference
|
|
---
|
|
|
|
<ComponentExample src="/components/examples/sheet/demo.tsx">
|
|
<SheetDemo />
|
|
</ComponentExample>
|
|
|
|
## Installation
|
|
|
|
1. Install the `@radix-ui/react-dialog` component from radix-ui:
|
|
|
|
```bash
|
|
npm install @radix-ui/react-dialog
|
|
```
|
|
|
|
2. Copy and paste the following code into your project.
|
|
|
|
<ComponentSource src="/components/ui/sheet.tsx" />
|
|
|
|
<Callout>
|
|
|
|
This is the `<Sheet />` primitive. You can place it in a file at `components/ui/sheet.tsx`.
|
|
|
|
</Callout>
|
|
|
|
## Usage
|
|
|
|
```tsx
|
|
import {
|
|
Sheet,
|
|
SheetContent,
|
|
SheetDescription,
|
|
SheetHeader,
|
|
SheetTitle,
|
|
SheetTrigger,
|
|
} from "@/components/ui/dialog"
|
|
```
|
|
|
|
```tsx
|
|
<Sheet>
|
|
<SheetTrigger>Open</SheetTrigger>
|
|
<SheetContent>
|
|
<SheetHeader>
|
|
<SheetTitle>Are you sure 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
|
|
|
|
### Position
|
|
|
|
Pass the `position` property to `<SheetContent />` to indicate the edge of the screen where the component will appear. The values can be `top`, `right`, `bottom` or `left`.
|
|
|
|
<ComponentExample src="/components/examples/sheet/position.tsx">
|
|
<SheetPosition />
|
|
</ComponentExample>
|
|
|
|
---
|
|
|
|
### Size
|
|
|
|
Pass the `size` property to `<SheetContent />` if you need to adjust the size of the sheet. The values can be `sm`, `default`, `lg`, `xl`, `full` or `content`.
|
|
|
|
<ComponentExample src="/components/examples/sheet/size.tsx">
|
|
<SheetSize />
|
|
</ComponentExample>
|