mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-24 13:15:45 +00:00
38de7fddc2
* feat: rtl * feat * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * feat: add sidebar * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * chore: changeset * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix
123 lines
2.5 KiB
Plaintext
123 lines
2.5 KiB
Plaintext
---
|
|
title: Dialog
|
|
description: A window overlaid on either the primary window or another dialog window, rendering the content underneath inert.
|
|
featured: true
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/dialog
|
|
api: https://base-ui.com/react/components/dialog#api-reference
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="dialog-demo"
|
|
description="A dialog for editing profile details."
|
|
/>
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add dialog
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<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="dialog"
|
|
title="components/ui/dialog.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
Dialog,
|
|
DialogContent,
|
|
DialogDescription,
|
|
DialogHeader,
|
|
DialogTitle,
|
|
DialogTrigger,
|
|
} from "@/components/ui/dialog"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<Dialog>
|
|
<DialogTrigger>Open</DialogTrigger>
|
|
<DialogContent>
|
|
<DialogHeader>
|
|
<DialogTitle>Are you absolutely sure?</DialogTitle>
|
|
<DialogDescription>
|
|
This action cannot be undone. This will permanently delete your account
|
|
and remove your data from our servers.
|
|
</DialogDescription>
|
|
</DialogHeader>
|
|
</DialogContent>
|
|
</Dialog>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Custom Close Button
|
|
|
|
Replace the default close control with your own button.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dialog-close-button" />
|
|
|
|
### No Close Button
|
|
|
|
Use `showCloseButton={false}` to hide the close button.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dialog-no-close-button" />
|
|
|
|
### Sticky Footer
|
|
|
|
Keep actions visible while the content scrolls.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dialog-sticky-footer" />
|
|
|
|
### Scrollable Content
|
|
|
|
Long content can scroll while the header stays in view.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dialog-scrollable-content" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="base-nova" name="dialog-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI](https://base-ui.com/react/components/dialog#api-reference) documentation for more information.
|