186 lines
4.1 KiB
Plaintext
186 lines
4.1 KiB
Plaintext
---
|
|
title: Alert Dialog
|
|
description: A modal dialog that interrupts the user with important content and expects a response.
|
|
featured: true
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/alert-dialog
|
|
api: https://base-ui.com/react/components/alert-dialog#api-reference
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="alert-dialog-demo"
|
|
previewClassName="h-56"
|
|
/>
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add alert-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="alert-dialog"
|
|
title="components/ui/alert-dialog.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
AlertDialog,
|
|
AlertDialogAction,
|
|
AlertDialogCancel,
|
|
AlertDialogContent,
|
|
AlertDialogDescription,
|
|
AlertDialogFooter,
|
|
AlertDialogHeader,
|
|
AlertDialogTitle,
|
|
AlertDialogTrigger,
|
|
} from "@/components/ui/alert-dialog"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<AlertDialog>
|
|
<AlertDialogTrigger render={<Button variant="outline" />}>
|
|
Show Dialog
|
|
</AlertDialogTrigger>
|
|
<AlertDialogContent>
|
|
<AlertDialogHeader>
|
|
<AlertDialogTitle>Are you absolutely sure?</AlertDialogTitle>
|
|
<AlertDialogDescription>
|
|
This action cannot be undone. This will permanently delete your account
|
|
from our servers.
|
|
</AlertDialogDescription>
|
|
</AlertDialogHeader>
|
|
<AlertDialogFooter>
|
|
<AlertDialogCancel>Cancel</AlertDialogCancel>
|
|
<AlertDialogAction>Continue</AlertDialogAction>
|
|
</AlertDialogFooter>
|
|
</AlertDialogContent>
|
|
</AlertDialog>
|
|
```
|
|
|
|
## Composition
|
|
|
|
Use the following composition to build an `AlertDialog`:
|
|
|
|
```text
|
|
AlertDialog
|
|
├── AlertDialogTrigger
|
|
└── AlertDialogContent
|
|
├── AlertDialogHeader
|
|
│ ├── AlertDialogMedia
|
|
│ ├── AlertDialogTitle
|
|
│ └── AlertDialogDescription
|
|
└── AlertDialogFooter
|
|
├── AlertDialogCancel
|
|
└── AlertDialogAction
|
|
```
|
|
|
|
## Basic
|
|
|
|
A basic alert dialog with a title, description, and cancel and continue buttons.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="alert-dialog-basic"
|
|
previewClassName="h-56"
|
|
/>
|
|
|
|
## Small
|
|
|
|
Use the `size="sm"` prop to make the alert dialog smaller.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="alert-dialog-small"
|
|
previewClassName="h-56"
|
|
/>
|
|
|
|
## Media
|
|
|
|
Use the `AlertDialogMedia` component to add a media element such as an icon or image to the alert dialog.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="alert-dialog-media"
|
|
previewClassName="h-56"
|
|
/>
|
|
|
|
## Small with Media
|
|
|
|
Use the `size="sm"` prop to make the alert dialog smaller and the `AlertDialogMedia` component to add a media element such as an icon or image to the alert dialog.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="alert-dialog-small-media"
|
|
previewClassName="h-56"
|
|
/>
|
|
|
|
## Destructive
|
|
|
|
Use the `AlertDialogAction` component to add a destructive action button to the alert dialog.
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="alert-dialog-destructive"
|
|
previewClassName="h-56"
|
|
/>
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="alert-dialog-rtl"
|
|
direction="rtl"
|
|
previewClassName="h-56"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
### size
|
|
|
|
Use the `size` prop on the `AlertDialogContent` component to control the size of the alert dialog. It accepts the following values:
|
|
|
|
| Prop | Type | Default |
|
|
| ------ | ------------------- | ----------- |
|
|
| `size` | `"default" \| "sm"` | `"default"` |
|
|
|
|
For more information about the other components and their props, see the [Base UI documentation](https://base-ui.com/react/components/alert-dialog#api-reference).
|