Confirm modal
Use the EuiConfirmModal to ask the user to confirm a decision. It is a contextual wrapper around EuiModal that provides some helpful props for filling in common modal pieces. By default, the button color indicates a positive or neutral action. Change the
buttonColor
property to danger
to indicate a destructive action.Loading and disabling confirm button
EuiConfirmModal supports being able to apply loading and disabled states to the confirm button with the confirmButtonDisabled
and isLoading
props respectively. This is helpful to indicate the fetching of data and/or to wait for a user's input before enabling the confirm action.
Props
EuiConfirmModal
Prop | Description and type | Default value |
---|---|---|
Prop onCancel# | Description and type Type: (event?: any) => void | Default value Required |
Prop children# | Description and type ReactNode to render as this component's content ReactNode | Default value |
Prop title# | Description and type Type: ReactNode | Default value |
Prop titleProps# | Description and type Type: Omit<EuiTitleProps, "children"> & HTMLAttributes<HTMLHeadingElement> & { component?: ElementType; } | Default value |
Prop cancelButtonText# | Description and type Type: ReactNode | Default value |
Prop confirmButtonText# | Description and type Type: ReactNode | Default value |
Prop onConfirm# | Description and type Type: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | Default value |
Prop confirmButtonDisabled# | Description and type Type: boolean | Default value |
Prop className# | Description and type Type: string | Default value |
Prop defaultFocusedButton# | Description and type Allows focusing either the confirm or cancel button on modal initialization. "cancel" | "confirm" | Default value |
Prop buttonColor# | Description and type Type: "primary" | "text" | "accent" | "accentSecondary" | "success" | "warning" | "danger" | Default value primary |
Prop maxWidth# | Description and type Sets the max-width of the modal. string | number | boolean | Default value |
Prop isLoading# | Description and type Passes boolean | Default value |
Prop role# | Description and type Identifies a modal dialog to screen readers. Modal dialogs that confirm destructive actions "dialog" | "alertdialog" | Default value |
Prop aria-label# | Description and type Defines a string value that labels the current element. string | Default value |
Prop initialFocus# | Description and type Specifies what element should initially have focus. string | HTMLElement | (() => HTMLElement) | Default value |