Skip to main content

Starwind UI v3.0 is now available! Migration guide

Alert Dialog

Are you absolutely sure?

This action cannot be undone. This will permanently delete your account and remove your data from our servers.

Installation

Usage

---
import { AlertDialog, AlertDialogTrigger, AlertDialogContent, AlertDialogHeader, AlertDialogFooter, AlertDialogTitle, AlertDialogDescription, AlertDialogCancel, AlertDialogAction } from "@/components/starwind/alert-dialog";
import { Button } from "@/components/starwind/button";
---
<AlertDialog>
<AlertDialogTrigger asChild>
<Button variant="outline">Show Alert Dialog</Button>
</AlertDialogTrigger>
<AlertDialogContent>
<AlertDialogHeader>
<AlertDialogTitle>Are you absolutely sure?</AlertDialogTitle>
<AlertDialogDescription>
This action cannot be undone. This will permanently delete your account and remove
your data from our servers.
</AlertDialogDescription>
</AlertDialogHeader>
<AlertDialogFooter>
<AlertDialogCancel>Cancel</AlertDialogCancel>
<AlertDialogAction>Continue</AlertDialogAction>
</AlertDialogFooter>
</AlertDialogContent>
</AlertDialog>

Composition

Use this structure for an alert dialog:

AlertDialog
├── AlertDialogTrigger
└── AlertDialogContent
├── AlertDialogHeader
│ ├── AlertDialogTitle
│ └── AlertDialogDescription
└── AlertDialogFooter
├── AlertDialogCancel
└── AlertDialogAction

When to Use

Use an alert dialog when the user must confirm a critical action or acknowledge important information before continuing.

Destructive Actions

Alert dialogs are commonly used to confirm destructive actions like deleting data.

Delete Account

Are you sure you want to delete your account? This action is permanent and cannot be undone. All your data, including projects, settings, and personal information will be permanently removed.

Custom Styling

You can customize the appearance of alert dialog components using the class prop.

Custom Alert Dialog

This alert dialog has custom styling applied to make it more compact and centered.

API Reference

Styled Component API

These props are added or materially changed by the installed styled component. Standard HTML attributes remain available through the inherited interfaces noted below. Expand a prop to see named type definitions and framework-specific imports. Follow the Primitive and Runtime links for lower-level behavior props.

Alert Dialog Trigger

Inherits button attributes.

Contains the following additional props:

Prop Type Default Toggle details
asChild boolean false
Description
Merges the component behavior and props into its child element.
Classification
Primitive override
Primitive prop
alert-dialog.Trigger.asChild

Alert Dialog Action

Inherits Button props.

Contains the following additional props:

Prop Type Default Toggle details
asChild boolean false
Description
Merges the component behavior and props into its child element.
Classification
Wrapper prop

Alert Dialog Cancel

Inherits Button props.

Contains the following additional props:

Prop Type Default Toggle details
asChild boolean false
Description
Merges the component behavior and props into its child element.
Classification
Wrapper prop

Primitive And Runtime API

Use these references when you need the lower-level behavior APIs behind Alert Dialog.

Runtime API

Alert Dialog primitive
createAlertDialog from @starwind-ui/runtime/alert-dialog

Changelog

View version history v2.1.0 4 releases

v2.1.0

  • In Astro, AlertDialogTrigger with asChild now makes your own element a working trigger. Before, a button child gave a control that did nothing.
  • In Astro, an attribute that you set on AlertDialog and its parts now wins over the component’s own default for the same attribute, such as role or aria-label.
  • In Svelte, a defined open that you pass when AlertDialog mounts now stays under your control, as in React and Vue. To change it, use bind: or update your state in the change callback. A form reset keeps it. If you pass undefined at mount, AlertDialog keeps its own state.

v2.0.3

  • Vue Alert Dialog keeps its current open state when a change is canceled and responds to later open or close requests from your app.
  • Trigger, action, and cancel buttons added after the dialog mounts now work without reopening it.
  • Reduced background work when a React page uses multiple menus, tooltips, or other portals.
  • Fixed nested Svelte overlays inside a dialog appearing behind their parent or failing to receive clicks.
  • Fixed nested overlays appearing behind their parent in Vue and Svelte. Overlays can now render under the document body; if custom CSS or DOM queries require them to stay inside a parent, set a portal container or add data-floating-root to that parent.
  • Fixed React 18 retaining removed popup elements when the parent component stays mounted.

v2.0.2

  • The default export in index.ts now has a name, AlertDialogParts, so framework tools show a clear name.

v2.0.0

  • Alert Dialog now gets its behavior from Starwind Runtime. Runtime handles the modal state, focus, and closing of the confirmation dialog.
  • See the Alert Dialog Primitive for the unstyled parts and the behavior API.