Alert Dialog
Confirmation/destructive modal built on the Dialog kernel; a backdrop press or Escape never closes it.
Identity
Section titled “Identity”- Category: Overlays & feedback
- Status: stable public Registry/export-map component family
- Targets: iOS · Android · Web, subject to the compatibility contract
- Prerequisites:
@beemvp/beeui-uiinstalled (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup. - Source:
packages/ui/src/components/alert-dialog.tsx
Import
Section titled “Import”import { AlertDialog, AlertDialogAction, AlertDialogCancel, AlertDialogContent, AlertDialogDescription, AlertDialogFooter, AlertDialogTitle, AlertDialogTrigger } from '@beemvp/beeui-ui';There is no documented deep/private source import. For source ownership from a BeeUI checkout:
pnpm beeui add alert-dialogRegistry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.
Composition and public API
Section titled “Composition and public API”- Family exports:
AlertDialogAlertDialogActionAlertDialogCancelAlertDialogContentAlertDialogDescriptionAlertDialogFooterAlertDialogTitleAlertDialogTrigger- Also routed here, outside the Registry family:
alert-dialog
- Package export subpath:
@beemvp/beeui-ui/alert-dialog
- Also routed here, outside the Registry family:
Exported types: AlertDialogActionProps, AlertDialogCancelProps, AlertDialogContentProps, AlertDialogDescriptionProps, AlertDialogFooterProps, AlertDialogProps, AlertDialogTitleProps, AlertDialogTriggerProps
The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.
State and behavior contract
Section titled “State and behavior contract”Confirmation/destructive modal sharing Dialog’s controlled (open+onOpenChange, both required together) or uncontrolled (defaultOpen) contract; unlike Dialog it never closes from a backdrop press or an Escape keypress. It does still close on a native request-close — Android’s hardware back button, and iOS accessibility escape — because cancelOnRequestClose defaults to true; set it to false when only an explicit AlertDialogCancel/AlertDialogAction may dismiss the dialog.
AlertDialogActionProps
Section titled “AlertDialogActionProps”AlertDialogActionProps is exactly DialogCloseProps.
| Prop | Type | Default | Description |
|---|---|---|---|
children |
React.ReactNode |
— | Content rendered inside this element. The family’s composition section states which children it expects. |
className |
string |
— | Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee. |
labelClassName |
string |
— | Extra utility classes for the label text specifically, merged after the component’s own. |
loading |
boolean |
false |
Shows a spinner in place of the label, sets aria-busy, and disables presses. Defaults to false. |
size |
'sm' | 'md' | 'lg' | 'icon' |
'md' |
Chooses this element’s size from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there. |
variant |
'primary' | 'secondary' | 'outline' | 'ghost' | 'destructive' |
'destructive' |
Chooses this element’s variant from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there. |
Also carries every prop of Omit<PressableProps, 'accessibilityRole' | 'role' | 'children'> — that upstream contract is not reproduced here.
AlertDialogCancelProps
Section titled “AlertDialogCancelProps”AlertDialogCancelProps is exactly DialogCloseProps.
| Prop | Type | Default | Description |
|---|---|---|---|
children |
React.ReactNode |
— | Content rendered inside this element. The family’s composition section states which children it expects. |
className |
string |
— | Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee. |
labelClassName |
string |
— | Extra utility classes for the label text specifically, merged after the component’s own. |
loading |
boolean |
false |
Shows a spinner in place of the label, sets aria-busy, and disables presses. Defaults to false. |
size |
'sm' | 'md' | 'lg' | 'icon' |
'md' |
Chooses this element’s size from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there. |
variant |
'primary' | 'secondary' | 'outline' | 'ghost' | 'destructive' |
'outline' |
Chooses this element’s variant from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there. |
Also carries every prop of Omit<PressableProps, 'accessibilityRole' | 'role' | 'children'> — that upstream contract is not reproduced here.
AlertDialogContentProps
Section titled “AlertDialogContentProps”| Prop | Type | Default | Description |
|---|---|---|---|
cancelOnRequestClose |
boolean |
true |
Whether native request-close paths (Android hardware back and accessibility escape) should behave like cancellation. Backdrop presses never dismiss an AlertDialog. |
Also carries every prop of Omit<DialogContentProps, 'closeOnBackdropPress' | 'dismissOnEscape' | 'dismissOnRequestClose' | 'role'> — documented on the Dialog page, not reproduced here.
AlertDialogDescriptionProps
Section titled “AlertDialogDescriptionProps”AlertDialogDescriptionProps is exactly DialogDescriptionProps.
No own fields; this type is exactly the base(s) below.
Also carries every prop of Omit<TextProps, 'tone' | 'variant'> — documented on the Text page, not reproduced here.
AlertDialogFooterProps
Section titled “AlertDialogFooterProps”AlertDialogFooterProps is exactly DialogFooterProps.
| Prop | Type | Default | Description |
|---|---|---|---|
className |
string |
— | Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee. |
Also carries every prop of ViewProps — that upstream contract is not reproduced here.
AlertDialogProps
Section titled “AlertDialogProps”AlertDialogProps is exactly DialogProps, one of the following mutually exclusive variants:
Variant DialogControlledProps:
| Prop | Type | Default | Description |
|---|---|---|---|
children |
React.ReactNode |
— | Content rendered inside this element. The family’s composition section states which children it expects. |
defaultOpen |
never |
false |
Not accepted in the controlled variant, where open already owns the state. Pass defaultOpen on its own, without open, to use the uncontrolled variant. |
onOpenChange (required) |
(open: boolean) => void |
— | Applies a requested open state, and is required here because the controlled variant never updates its own visibility. If this does not change open, nothing does. |
open (required) |
boolean |
— | Current open state, owned by the caller; supplying a defined value alongside onOpenChange is what selects the controlled variant. Passing open without an onOpenChange function warns in development and falls back to uncontrolled behavior. |
Variant DialogUncontrolledProps:
| Prop | Type | Default | Description |
|---|---|---|---|
children |
React.ReactNode |
— | Content rendered inside this element. The family’s composition section states which children it expects. |
defaultOpen |
boolean |
false |
Open state to start from, read once when the component mounts, so later changes to it are ignored. Defaults to false; drive visibility with open + onOpenChange instead when it needs to change. |
onOpenChange |
(open: boolean) => void |
— | Notified after the open state changes, and optional here because the uncontrolled variant updates its own state either way. |
open |
undefined |
— | Must be left undefined in the uncontrolled variant, because a defined open together with onOpenChange selects the controlled variant instead. |
AlertDialogTitleProps
Section titled “AlertDialogTitleProps”AlertDialogTitleProps is exactly DialogTitleProps.
No own fields; this type is exactly the base(s) below.
Also carries every prop of Omit<TextProps, 'accessibilityRole' | 'role' | 'variant'> — documented on the Text page, not reproduced here.
AlertDialogTriggerProps
Section titled “AlertDialogTriggerProps”AlertDialogTriggerProps is exactly DialogTriggerProps.
| Prop | Type | Default | Description |
|---|---|---|---|
children |
React.ReactNode |
— | Content rendered inside this element. The family’s composition section states which children it expects. |
className |
string |
— | Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee. |
labelClassName |
string |
— | Extra utility classes for the label text specifically, merged after the component’s own. |
loading |
boolean |
false |
Shows a spinner in place of the label, sets aria-busy, and disables presses. Defaults to false. |
size |
'sm' | 'md' | 'lg' | 'icon' |
'md' |
Chooses this element’s size from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there. |
variant |
'primary' | 'secondary' | 'outline' | 'ghost' | 'destructive' |
'primary' |
Chooses this element’s variant from buttonVariants’s presets, declared in packages/ui/src/components/button.tsx — the classes each value applies are there. |
Also carries every prop of Omit<PressableProps, 'accessibilityRole' | 'role' | 'children'> — that upstream contract is not reproduced here.
This is the pressable itself — the same variant/size/press API as Button — so icon/label children go directly inside it. Do not nest a second pressable (an icon button, or an avatar wrapped for press) inside a *Trigger: on Web that renders one interactive element inside another, which React flags as invalid DOM nesting. For an icon-only or avatar trigger, set variant="ghost" (and size/className as needed) on the trigger itself instead of wrapping a second pressable.
The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.
Provider and dependencies
Section titled “Provider and dependencies”BeeUIProvideris required above this family because it participates in shared overlay/toast runtime infrastructure.- Peer/native dependencies visible to this Registry item:
react,react-native - Registry dependency closure:
dialog,theme - Safe-area ownership remains explicit: shell surfaces touching system edges opt into
SafeArea; components do not silently invent app-shell insets. - Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.
Platform behavior
Section titled “Platform behavior”This family ships no platform-specific file, and its own source takes no Platform branch.
The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.
Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.
Accessibility
Section titled “Accessibility”- Roles this family assigns:
alertdialog— set inalert-dialog.tsxby the components themselves, not by the caller. - Accessibility states and properties it sets: none set in
alert-dialog.tsx.
Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.
Styling and theming
Section titled “Styling and theming”- Style axes:
size(4 values),variant(5 values),tone(8 values, inherited fromTextProps). - Class-name surfaces:
className,containerClassName,labelClassName,overlayClassName.
Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.
Executable examples
Section titled “Executable examples”- Primary executable fixture:
apps/showcase/__tests__/dialog-web-modal-owner.test.tsx - Additional fixture:
apps/showcase/__tests__/issue-15-alert-dialog-form-group.test.tsx - Additional fixture:
apps/showcase/__tests__/overlay-scope.test.tsx - Additional fixture:
apps/showcase/__tests__/overlay-transport.test.tsx
Addressable examples
Section titled “Addressable examples”Each link below opens the Showcase at that exact example, not at the top of the gallery:
basic— smallest meaningful complete usage
The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.
Live Web preview
Section titled “Live Web preview”This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.
Composition anatomy
Section titled “Composition anatomy”- Family root / primary export:
AlertDialog- Public composition parts / helpers:
AlertDialogActionAlertDialogCancelAlertDialogContentAlertDialogDescriptionAlertDialogFooterAlertDialogTitleAlertDialogTrigger
- Exported type surface:
AlertDialogActionPropsAlertDialogCancelPropsAlertDialogContentPropsAlertDialogDescriptionPropsAlertDialogFooterPropsAlertDialogPropsAlertDialogTitlePropsAlertDialogTriggerProps
- Public composition parts / helpers:
The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.
Verified example source
Section titled “Verified example source”These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Alert Dialog is actually used: 13 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.
Imports the examples below need (a filtered subset of the fixture’s own top-level imports):
import { AlertDialog, AlertDialogAction, AlertDialogCancel, AlertDialogContent, AlertDialogDescription, AlertDialogFooter, AlertDialogTitle, AlertDialogTrigger } from '@beemvp/beeui-ui'; <AlertDialog> <AlertDialogTrigger variant="destructive">Delete project</AlertDialogTrigger> <AlertDialogContent> <AlertDialogTitle>Delete this project?</AlertDialogTitle> <AlertDialogDescription> The backdrop cannot dismiss this confirmation. Choose an explicit action instead. </AlertDialogDescription> <AlertDialogFooter> <AlertDialogCancel>Cancel</AlertDialogCancel> <AlertDialogAction>Delete permanently</AlertDialogAction> </AlertDialogFooter> </AlertDialogContent> </AlertDialog>Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.
Limitations
Section titled “Limitations”Never dismisses from backdrop press or Escape, but native request-close — Android hardware back and accessibility escape — does dismiss it unless cancelOnRequestClose is false; not a general-purpose modal (use Dialog).