Skip to content
Edit this page

Alert API

API documentation for the React Alert component. Learn about the available props and the CSS API.

Import

import Alert from '@mui/material/Alert';
// or
import { Alert } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiAlert can be used when providing default props or style overrides in the theme.

Props

Props of the Paper component are also available.

NameTypeDefaultDescription
actionnode
The action to display. It renders after the message, at the end of the alert.
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
closeTextstring'Close'
Override the default label for the close popup icon button.
For localization purposes, you can use the provided translations.
color'error'
| 'info'
| 'success'
| 'warning'
| string
The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
components{ CloseButton?: elementType, CloseIcon?: elementType }{}
The components used for each slot inside the Alert. Either a string to use a HTML element or a component.
componentsProps{ closeButton?: object, closeIcon?: object }{}
The props used for each slot inside.
iconnode
Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon.
iconMapping{ error?: node, info?: node, success?: node, warning?: node }
The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined>. If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed.
onClosefunc
Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.

Signature:
function(event: React.SyntheticEvent) => void
event: The event source of the callback.
rolestring'alert'
The ARIA role attribute of the element.
severity'error'
| 'info'
| 'success'
| 'warning'		'success'
The severity of the alert. This defines the color and icon used.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'filled'
| 'outlined'
| 'standard'
| string		'standard'
The variant to use.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Paper component are also available on Alert. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiAlert-rootStyles applied to the root element.
filled.MuiAlert-filledStyles applied to the root element if variant="filled".
outlined.MuiAlert-outlinedStyles applied to the root element if variant="outlined".
standard.MuiAlert-standardStyles applied to the root element if variant="standard".
standardSuccess.MuiAlert-standardSuccessStyles applied to the root element if variant="standard" and color="success".
standardInfo.MuiAlert-standardInfoStyles applied to the root element if variant="standard" and color="info".
standardWarning.MuiAlert-standardWarningStyles applied to the root element if variant="standard" and color="warning".
standardError.MuiAlert-standardErrorStyles applied to the root element if variant="standard" and color="error".
outlinedSuccess.MuiAlert-outlinedSuccessStyles applied to the root element if variant="outlined" and color="success".
outlinedInfo.MuiAlert-outlinedInfoStyles applied to the root element if variant="outlined" and color="info".
outlinedWarning.MuiAlert-outlinedWarningStyles applied to the root element if variant="outlined" and color="warning".
outlinedError.MuiAlert-outlinedErrorStyles applied to the root element if variant="outlined" and color="error".
filledSuccess.MuiAlert-filledSuccessStyles applied to the root element if variant="filled" and color="success".
filledInfo.MuiAlert-filledInfoStyles applied to the root element if variant="filled" and color="info".
filledWarning.MuiAlert-filledWarningStyles applied to the root element if variant="filled" and color="warning".
filledError.MuiAlert-filledErrorStyles applied to the root element if variant="filled" and color="error".
icon.MuiAlert-iconStyles applied to the icon wrapper element.
message.MuiAlert-messageStyles applied to the message wrapper element.
action.MuiAlert-actionStyles applied to the action wrapper element if action is provided.

You can override the style of the component using one of these customization options:

Demos