Alert Dialog

A modal dialog that interrupts the user's workflow to communicate an important message and acquire a response. Examples include action confirmation prompts and error message confirmations. The alertdialog role enables assistive technologies and browsers to distinguish alert dialogs from other dialogs so they have the option of giving alert dialogs special treatment, such as playing a system alert sound.

Import

ts
import { AlertDialog } from "@kobalte/core";

ts
import { AlertDialog } from "@kobalte/core";

Features

Follow the WAI ARIA Alert Dialog design pattern.
Supports modal and non-modal modes.
Provides screen reader announcements via rendered title and description.
Focus is trapped and scrolling is blocked while it is open.
Pressing Esc closes the alert dialog.
Can be controlled or uncontrolled.

Anatomy

The alert dialog consists of:

AlertDialog.Root: Contains all the parts of a dialog.
AlertDialog.Trigger: The button that opens the dialog.
AlertDialog.Portal: Portals its children into the body when the dialog is open.
AlertDialog.Overlay: The layer that covers the inert portion of the view when the dialog is open.
AlertDialog.Content: Contains the content to be rendered when the dialog is open.
AlertDialog.CloseButton: The button that closes the dialog.
AlertDialog.Title: An accessible title to be announced when the dialog is opened.
AlertDialog.Description: An optional accessible description to be announced when the dialog is opened.

tsx
<AlertDialog.Root>
	<AlertDialog.Trigger />
	<AlertDialog.Portal>
		<AlertDialog.Overlay />
		<AlertDialog.Content>
			<AlertDialog.CloseButton />
			<AlertDialog.Title />
			<AlertDialog.Description />
		</AlertDialog.Content>
	</AlertDialog.Portal>
</AlertDialog.Root>

tsx
<AlertDialog.Root>
	<AlertDialog.Trigger />
	<AlertDialog.Portal>
		<AlertDialog.Overlay />
		<AlertDialog.Content>
			<AlertDialog.CloseButton />
			<AlertDialog.Title />
			<AlertDialog.Description />
		</AlertDialog.Content>
	</AlertDialog.Portal>
</AlertDialog.Root>

Example

Usage

Default open

An initial, uncontrolled open value can be provided using the defaultOpen prop.

tsx
<AlertDialog.Root defaultOpen>...</AlertDialog.Root>

tsx
<AlertDialog.Root defaultOpen>...</AlertDialog.Root>

Controlled open

The open prop can be used to make the open state controlled. The onOpenChange event is fired when the user presses the trigger, close button or overlay, and receives the new value.

tsx
import { createSignal } from "solid-js";
function ControlledExample() {
	const [open, setOpen] = createSignal(false);
	return (
		<AlertDialog.Root open={open()} onOpenChange={setOpen}>
			...
		</AlertDialog.Root>
	);
}

tsx
import { createSignal } from "solid-js";
function ControlledExample() {
	const [open, setOpen] = createSignal(false);
	return (
		<AlertDialog.Root open={open()} onOpenChange={setOpen}>
			...
		</AlertDialog.Root>
	);
}

API Reference

AlertDialog.Root

Prop	Description
open	`boolean` The controlled open state of the dialog.
defaultOpen	`boolean` The default open state when initially rendered. Useful when you do not need to control the open state.
onOpenChange	`(open: boolean) => void` Event handler called when the open state of the dialog changes.
id	`string` A unique identifier for the component. The id is used to generate id attributes for nested components. If no id prop is provided, a generated id will be used.
modal	`boolean` Whether the dialog should be the only visible content for screen readers, when set to `true`: - interaction with outside elements will be disabled. - scroll will be locked. - focus will be locked inside the dialog content. - elements outside the dialog content will not be visible for screen readers.
preventScroll	`boolean` Whether the scroll should be locked even if the alert dialog is not modal.
forceMount	`boolean` Used to force mounting the dialog (portal, overlay and content) when more control is needed. Useful when controlling animation with SolidJS animation libraries.

AlertDialog.Trigger

AlertDialog.Trigger consists of Button.

Data attribute	Description
data-expanded	Present when the dialog is open.
data-closed	Present when the dialog is close.

AlertDialog.Content and AlertDialog.Overlay shares the same data-attributes.

AlertDialog.Content

Prop	Description
onOpenAutoFocus	`(event: Event) => void` Event handler called when focus moves into the component after opening. It can be prevented by calling `event.preventDefault`.
onCloseAutoFocus	`(event: Event) => void` Event handler called when focus moves to the trigger after closing. It can be prevented by calling `event.preventDefault`.
onEscapeKeyDown	`(event: KeyboardEvent) => void` Event handler called when the escape key is down. It can be prevented by calling `event.preventDefault`.
onPointerDownOutside	`(event: PointerDownOutsideEvent) => void` Event handler called when a pointer event occurs outside the bounds of the component. It can be prevented by calling `event.preventDefault`.
onFocusOutside	`(event: FocusOutsideEvent) => void` Event handler called when the focus moves outside the bounds of the component. It can be prevented by calling `event.preventDefault`.
onInteractOutside	`(event: InteractOutsideEvent) => void` Event handler called when an interaction (pointer or focus event) happens outside the bounds of the component. It can be prevented by calling `event.preventDefault`.

Rendered elements

Component	Default rendered element
`AlertDialog.Root`	none
`AlertDialog.Trigger`	`button`
`AlertDialog.Portal`	`Portal`
`AlertDialog.Overlay`	`div`
`AlertDialog.Content`	`div`
`AlertDialog.CloseButton`	`button`
`AlertDialog.Title`	`h2`
`AlertDialog.Description`	`p`

Accessibility

Keyboard Interactions

Key	Description
`Space`	When focus is on the trigger, opens/closes the dialog.
`Enter`	When focus is on the trigger, opens/closes the dialog.
`Tab`	Moves focus to the next focusable element.
`Shift` + `Tab`	Moves focus to the previous focusable element.
`Esc`	Closes the dialog and moves focus to the trigger.