AlertDialog

Ask for a deliberate response before an important action.

Interactive playground

LIVE PREVIEW

Generated code

import { useState } from 'react';
import { AlertDialog } from '@vrum/ui';
import { AlertDialogTrigger, Button, AlertDialogContent, AlertDialogHeader, AlertDialogTitle, AlertDialogDescription, AlertDialogFooter, AlertDialogCancel, AlertDialogAction } from '@vrum/ui';

export default function Demo() {
  const [open, setOpen] = useState(false);

  return (
    <AlertDialog
      open={open}
      onOpenChange={setOpen}
    >
      <AlertDialogTrigger asChild><Button variant="outline">Archive project</Button></AlertDialogTrigger><AlertDialogContent><AlertDialogHeader><AlertDialogTitle>Archive this project?</AlertDialogTitle><AlertDialogDescription>You can restore it from the archive later.</AlertDialogDescription></AlertDialogHeader><AlertDialogFooter><AlertDialogCancel asChild><Button variant="outline">Cancel</Button></AlertDialogCancel><AlertDialogAction asChild><Button>Archive</Button></AlertDialogAction></AlertDialogFooter></AlertDialogContent>
    </AlertDialog>
  );
}

AlertDialog props

Prop	Type	Default	Description
`children`	`React.ReactNode`	none	Content rendered inside the component.
`defaultOpen`	`boolean`	none	Initial visibility for an uncontrolled component.
`open`	`boolean`	none	Controlled visibility.
`onOpenChange`	`((open: boolean) => void)`	none	Called when visibility changes.

AlertDialogTrigger props

Prop	Type	Default	Description
`asChild`	`boolean`	none	as child configuration.
`disabled`	`boolean`	none	Disable user interaction.
`name`	`string`	none	name configuration.
`type`	`"submit" \| "reset" \| "button"`	none	type configuration.
`value`	`string \| number \| readonly string[]`	none	Controlled value.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLButtonElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLButtonElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLButtonElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLButtonElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLButtonElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLButtonElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLButtonElement>`	none	on select configuration.

AlertDialogContent props

Prop	Type	Default	Description
`asChild`	`boolean`	none	as child configuration.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.
`forceMount`	`true`	none	Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.
`onOpenAutoFocus`	`((event: Event) => void)`	none	Event handler called when auto-focusing on open. Can be prevented.
`onCloseAutoFocus`	`((event: Event) => void)`	none	Event handler called when auto-focusing on close. Can be prevented.
`onEscapeKeyDown`	`((event: KeyboardEvent) => void)`	none	Event handler called when the escape key is down. Can be prevented.
`onFocusOutside`	`((event: FocusOutsideEvent) => void)`	none	Event handler called when the focus moves outside of the `DismissableLayer`. Can be prevented.
`deferPointerDownOutside`	`boolean`	none	When `true`, a `'pointerdown'` event outside of the layered element will wait for the interaction's click event before dispatching, allowing third-party code to stop propagation of later events and cancel dismissal.

AlertDialogHeader props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

AlertDialogTitle props

Prop	Type	Default	Description
`asChild`	`boolean`	none	as child configuration.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLHeadingElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLHeadingElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLHeadingElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLHeadingElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLHeadingElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLHeadingElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLHeadingElement>`	none	on select configuration.

AlertDialogDescription props

Prop	Type	Default	Description
`asChild`	`boolean`	none	as child configuration.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLParagraphElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLParagraphElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLParagraphElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLParagraphElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLParagraphElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLParagraphElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLParagraphElement>`	none	on select configuration.

AlertDialogFooter props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

AlertDialogCancel props

Prop	Type	Default	Description
`asChild`	`boolean`	none	as child configuration.
`disabled`	`boolean`	none	Disable user interaction.
`name`	`string`	none	name configuration.
`type`	`"submit" \| "reset" \| "button"`	none	type configuration.
`value`	`string \| number \| readonly string[]`	none	Controlled value.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLButtonElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLButtonElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLButtonElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLButtonElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLButtonElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLButtonElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLButtonElement>`	none	on select configuration.

AlertDialogAction props

Prop	Type	Default	Description
`asChild`	`boolean`	none	as child configuration.
`disabled`	`boolean`	none	Disable user interaction.
`name`	`string`	none	name configuration.
`type`	`"submit" \| "reset" \| "button"`	none	type configuration.
`value`	`string \| number \| readonly string[]`	none	Controlled value.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLButtonElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLButtonElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLButtonElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLButtonElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLButtonElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLButtonElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLButtonElement>`	none	on select configuration.

AlertDialog

Interactive playground

Props

AlertDialog props

AlertDialogTrigger props

AlertDialogContent props

AlertDialogHeader props

AlertDialogTitle props

AlertDialogDescription props

AlertDialogFooter props

AlertDialogCancel props

AlertDialogAction props

AlertDialog

Interactive playground

Props

AlertDialog props

AlertDialogTrigger props

AlertDialogContent props

AlertDialogHeader props

AlertDialogTitle props

AlertDialogDescription props

AlertDialogFooter props

AlertDialogCancel props

AlertDialogAction props