Alert Dialog
A dialog that requires user response to proceed.
View as MarkdownAnatomy
Import the component and assemble its parts:
import { AlertDialog } from '@base-ui-components/react/alert-dialog';
<AlertDialog.Root>
  <AlertDialog.Trigger />
  <AlertDialog.Portal>
    <AlertDialog.Backdrop />
    <AlertDialog.Viewport>
      <AlertDialog.Popup>
        <AlertDialog.Title />
        <AlertDialog.Description />
        <AlertDialog.Close />
      </AlertDialog.Popup>
    </AlertDialog.Viewport>
  </AlertDialog.Portal>
</AlertDialog.Root>API reference
Root
Groups all parts of the alert dialog. Doesn’t render its own HTML element.
defaultOpenboolean
false
defaultOpenboolean
false
- Name
- Description
- Whether the dialog is initially open. - To render a controlled dialog, use the - openprop instead.
- Type
- boolean | undefined
- Default
- false
openboolean
—
openboolean
—- Name
- Description
- Whether the dialog is currently open. 
- Type
- boolean | undefined
onOpenChangefunction
—
onOpenChangefunction
—- Name
- Description
- Event handler called when the dialog is opened or closed. 
- Type
- | (( open: boolean, eventDetails: AlertDialog.Root.ChangeEventDetails, ) => void) | undefined
actionsRefRefObject<AlertDialog.Root.Actions>
—
actionsRefRefObject<AlertDialog.Root.Actions>
—- Name
- Description
- A ref to imperative actions. - unmount: When specified, the dialog will not be unmounted when closed. Instead, the- unmountfunction must be called to unmount the dialog manually. Useful when the dialog's animation is controlled by an external library.
 
- Type
- | React.RefObject<AlertDialog.Root.Actions> | undefined
defaultTriggerIdstring | null
—
defaultTriggerIdstring | null
—- Name
- Description
- ID of the trigger that the dialog is associated with. This is useful in conjunction with the - defaultOpenprop to create an initially open dialog.
- Type
- string | null | undefined
handleDialogHandle<Payload>
—
handleDialogHandle<Payload>
—- Name
- Description
- A handle to associate the popover with a trigger. If specified, allows external triggers to control the popover's open state. Can be created with the AlertDialog.createHandle() method. 
- Type
- {} | undefined
onOpenChangeCompletefunction
—
onOpenChangeCompletefunction
—- Description
- Event handler called after any animations complete when the dialog is opened or closed. 
- Type
- ((open: boolean) => void) | undefined
triggerIdstring | null
—
triggerIdstring | null
—- Name
- Description
- ID of the trigger that the dialog is associated with. This is useful in conjuntion with the - openprop to create a controlled dialog. There's no need to specify this prop when the popover is uncontrolled (i.e. when the- openprop is not set).
- Type
- string | null | undefined
childrenReactNode | PayloadChildRenderFunction<Payload>
—
childrenReactNode | PayloadChildRenderFunction<Payload>
—- Name
- Description
- The content of the dialog. This can be a regular React node or a render function that receives the - payloadof the active trigger.
- Type
- | React.ReactNode | ((arg: { payload: Payload | undefined }) => ReactNode)
Trigger
A button that opens the alert dialog.
Renders a <button> element.
handleDialogHandle<Payload>
—
handleDialogHandle<Payload>
—- Name
- Description
- A handle to associate the trigger with a dialog. Can be created with the AlertDialog.createHandle() method. 
- Type
- {} | undefined
nativeButtonboolean
true
nativeButtonboolean
true
- Name
- Description
- Whether the component renders a native - <button>element when replacing it via the- renderprop. Set to- falseif the rendered element is not a button (e.g.- <div>).
- Type
- boolean | undefined
- Default
- true
payloadPayload
—
payloadPayload
—- Name
- Description
- A payload to pass to the dialog when it is opened. 
- Type
- Payload | undefined
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Trigger.State, ) => CSSProperties | undefined) | undefined
idstring
—
idstring
—- Name
- Description
- ID of the trigger. In addition to being forwarded to the rendered element, it is also used to specify the active trigger for the dialogs in controlled mode (with the Dialog.Root - triggerIdprop).
- Type
- string | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | ((state: AlertDialog.Trigger.State) => string | undefined)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Trigger.State, ) => ReactElement)
data-popup-open
Present when the corresponding dialog is open.
data-disabled
Present when the trigger is disabled.
Portal
A portal element that moves the popup to a different part of the DOM.
By default, the portal element is appended to <body>.
Renders a <div> element.
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Portal.State, ) => CSSProperties | undefined) | undefined
containerUnion
—
containerUnion
—- Name
- Description
- A parent element to render the portal element into. 
- Type
- | HTMLElement | ShadowRoot | React.RefObject<HTMLElement | ShadowRoot | null> | null | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | (( state: AlertDialog.Portal.State, ) => string | undefined)
keepMountedboolean
false
keepMountedboolean
false
- Name
- Description
- Whether to keep the portal mounted in the DOM while the popup is hidden. 
- Type
- boolean | undefined
- Default
- false
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Portal.State, ) => ReactElement)
Backdrop
An overlay displayed beneath the popup.
Renders a <div> element.
forceRenderboolean
false
forceRenderboolean
false
- Name
- Description
- Whether the backdrop is forced to render even when nested. 
- Type
- boolean | undefined
- Default
- false
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Backdrop.State, ) => CSSProperties | undefined) | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | (( state: AlertDialog.Backdrop.State, ) => string | undefined)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Backdrop.State, ) => ReactElement)
data-open
Present when the dialog is open.
data-closed
Present when the dialog is closed.
data-starting-style
Present when the dialog is animating in.
data-ending-style
Present when the dialog is animating out.
Viewport
A positioning container for the dialog popup that can be made scrollable.
Renders a <div> element.
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Viewport.State, ) => CSSProperties | undefined) | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | (( state: AlertDialog.Viewport.State, ) => string | undefined)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Viewport.State, ) => ReactElement)
data-open
Present when the dialog is open.
data-closed
Present when the dialog is closed.
data-nested
Present when the dialog is nested within another dialog.
data-nested-dialog-open
Present when the dialog has other open dialogs nested within it.
data-starting-style
Present when the dialog is animating in.
data-ending-style
Present when the dialog is animating out.
Popup
A container for the alert dialog contents.
Renders a <div> element.
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Popup.State, ) => CSSProperties | undefined) | undefined
initialFocusUnion
—
initialFocusUnion
—- Name
- Description
- Determines the element to focus when the dialog is opened. - false: Do not move focus.
- true: Move focus based on the default behavior (first tabbable element or popup).
- RefObject: Move focus to the ref element.
- function: Called with the interaction type (- mouse,- touch,- pen, or- keyboard). Return an element to focus,- trueto use the default behavior, or- false/- undefinedto do nothing.
 
- Type
- | boolean | React.RefObject<HTMLElement | null> | (( openType: InteractionType, ) => boolean | void | HTMLElement | null) | undefined
finalFocusUnion
—
finalFocusUnion
—- Name
- Description
- Determines the element to focus when the dialog is closed. - false: Do not move focus.
- true: Move focus based on the default behavior (trigger or previously focused element).
- RefObject: Move focus to the ref element.
- function: Called with the interaction type (- mouse,- touch,- pen, or- keyboard). Return an element to focus,- trueto use the default behavior, or- false/- undefinedto do nothing.
 
- Type
- | boolean | React.RefObject<HTMLElement | null> | (( closeType: InteractionType, ) => boolean | void | HTMLElement | null) | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | ((state: AlertDialog.Popup.State) => string | undefined)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Popup.State, ) => ReactElement)
data-open
Present when the dialog is open.
data-closed
Present when the dialog is closed.
data-nested
Present when the dialog is nested within another dialog.
data-nested-dialog-open
Present when the dialog has other open dialogs nested within it.
data-starting-style
Present when the dialog is animating in.
data-ending-style
Present when the dialog is animating out.
--nested-dialogs
Indicates how many dialogs are nested within.
Title
A heading that labels the dialog.
Renders an <h2> element.
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Title.State, ) => CSSProperties | undefined) | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | ((state: AlertDialog.Title.State) => string | undefined)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Title.State, ) => ReactElement)
Description
A paragraph with additional information about the alert dialog.
Renders a <p> element.
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Description.State, ) => CSSProperties | undefined) | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | (( state: AlertDialog.Description.State, ) => string | undefined)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Description.State, ) => ReactElement)
Close
A button that closes the alert dialog.
Renders a <button> element.
nativeButtonboolean
true
nativeButtonboolean
true
- Name
- Description
- Whether the component renders a native - <button>element when replacing it via the- renderprop. Set to- falseif the rendered element is not a button (e.g.- <div>).
- Type
- boolean | undefined
- Default
- true
styleReact.CSSProperties | function
—
styleReact.CSSProperties | function
—- Name
- Type
- | React.CSSProperties | (( state: AlertDialog.Close.State, ) => CSSProperties | undefined) | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
- CSS class applied to the element, or a function that returns a class based on the component’s state. 
- Type
- | string | ((state: AlertDialog.Close.State) => string | undefined)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
- Allows you to replace the component’s HTML element with a different tag, or compose it with another component. - Accepts a - ReactElementor a function that returns the element to render.
- Type
- | ReactElement | (( props: HTMLProps, state: AlertDialog.Close.State, ) => ReactElement)
data-disabled
Present when the button is disabled.
Examples
Open from a menu
In order to open a dialog using a menu, control the dialog state and open it imperatively using the onClick handler on the menu item.
import * as React from 'react';
import { AlertDialog } from '@base-ui-components/react/alert-dialog';
import { Menu } from '@base-ui-components/react/menu';
function ExampleMenu() {
  const [dialogOpen, setDialogOpen] = React.useState(false);
  return (
    <React.Fragment>
      <Menu.Root>
        <Menu.Trigger>Open menu</Menu.Trigger>
        <Menu.Portal>
          <Menu.Positioner>
            <Menu.Popup>
              {/* Open the dialog when the menu item is clicked */}
              <Menu.Item onClick={() => setDialogOpen(true)}>Open dialog</Menu.Item>
            </Menu.Popup>
          </Menu.Positioner>
        </Menu.Portal>
      </Menu.Root>
      {/* Control the dialog state */}
      <AlertDialog.Root open={dialogOpen} onOpenChange={setDialogOpen}>
        <AlertDialog.Portal>
          <AlertDialog.Backdrop />
          <AlertDialog.Popup>
            {/* Rest of the dialog */}
          </AlertDialog.Popup>
        </AlertDialog.Portal>
      </AlertDialog.Root>
    </React.Fragment>
  );
}Close confirmation
This example shows a nested confirmation dialog that opens if the text entered in the parent dialog is going to be discarded.
To implement this, both dialogs should be controlled. The confirmation dialog may be opened when onOpenChange callback of the parent dialog receives a request to close. This way, the confirmation is automatically shown when the user clicks the backdrop, presses the Esc key, or clicks a close button.
Use the [data-nested-dialog-open] selector and the var(--nested-dialogs) CSS variable to customize the styling of the parent dialog. Backdrops of the child dialogs won’t be rendered so that you can present the parent dialog in a clean way behind the one on top of it.
Detached triggers
An alert dialog can be controlled by a trigger located either inside or outside the <AlertDialog.Root> component.
For simple, one-off interactions, place the <AlertDialog.Trigger> inside <AlertDialog.Root>, as shown in the example at the top of this page.
However, if defining the alert dialog’s content next to its trigger is not practical, you can use a detached trigger.
This involves placing the <AlertDialog.Trigger> outside of <AlertDialog.Root> and linking them with a handle created by the AlertDialog.createHandle() function.
const demoAlertDialog = AlertDialog.createHandle();
<AlertDialog.Trigger handle={demoAlertDialog}>Open</AlertDialog.Trigger>
<AlertDialog.Root handle={demoAlertDialog}>
  ...
</AlertDialog.Root>Multiple triggers
A single alert dialog can be opened by multiple trigger elements.
You can achieve this by using the same handle for several detached triggers, or by placing multiple <AlertDialog.Trigger> components inside a single <AlertDialog.Root>.
<AlertDialog.Root>
  <AlertDialog.Trigger>Trigger 1</AlertDialog.Trigger>
  <AlertDialog.Trigger>Trigger 2</AlertDialog.Trigger>
  ...
</AlertDialog.Root>const demoAlertDialog = AlertDialog.createHandle();
<AlertDialog.Trigger handle={demoAlertDialog}>Trigger 1</AlertDialog.Trigger>
<AlertDialog.Trigger handle={demoAlertDialog}>Trigger 2</AlertDialog.Trigger>
<AlertDialog.Root handle={demoAlertDialog}>
  ...
</AlertDialog.Root>The alert dialog can render different content depending on which trigger opened it.
This is achieved by passing a payload to the <AlertDialog.Trigger> and using the function-as-a-child pattern in <AlertDialog.Root>.
The payload can be strongly typed by providing a type argument to the createHandle() function:
const demoAlertDialog = AlertDialog.createHandle<{ message: string }>();
<AlertDialog.Trigger handle={demoAlertDialog} payload={{ message: 'Trigger 1' }}>
  Trigger 1
</AlertDialog.Trigger>
<AlertDialog.Trigger handle={demoAlertDialog} payload={{ message: 'Trigger 2' }}>
  Trigger 2
</AlertDialog.Trigger>
<AlertDialog.Root handle={demoAlertDialog}>
  {({ payload }) => (
    <AlertDialog.Portal>
      <AlertDialog.Popup>
        <AlertDialog.Title>Alert dialog</AlertDialog.Title>
        {payload !== undefined && (
          <AlertDialog.Description>
            Confirming {payload.message}
          </AlertDialog.Description>
        )}
      </AlertDialog.Popup>
    </AlertDialog.Portal>
  )}
</AlertDialog.Root>Controlled mode with multiple triggers
You can control the alert dialog’s open state externally using the open and onOpenChange props on <AlertDialog.Root>.
This allows you to manage the alert dialog’s visibility based on your application’s state.
When using multiple triggers, you have to manage which trigger is active with the triggerId prop on <AlertDialog.Root> and the id prop on each <AlertDialog.Trigger>.
Note that there is no separate onTriggerIdChange prop.
Instead, the onOpenChange callback receives an additional argument, eventDetails, which contains the trigger element that initiated the state change.