Skip to content
Edit this page

Alert API

The API documentation of the Alert React component. Learn more about the props and the CSS customization points.

Import

import Alert from '@material-ui/lab/Alert';
// or
import { Alert } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Component name

The MuiAlert name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
action node The action to display. It renders after the message, at the end of the alert.
children node The content of the component.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
closeText string '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'		 The main color for the alert. Unless provided, the value is taken from the severity prop.
icon node Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop.
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.
onClose func 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: object) => void
event: The event source of the callback.
role string '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.
variant 'filled'
| 'outlined'
| 'standard'		 'standard' The variant to use.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (Paper).

CSS

Rule name Global class Description
root .MuiAlert-root Styles applied to the root element.
standardSuccess .MuiAlert-standardSuccess Styles applied to the root element if variant="standard" and color="success".
standardInfo .MuiAlert-standardInfo Styles applied to the root element if variant="standard" and color="info".
standardWarning .MuiAlert-standardWarning Styles applied to the root element if variant="standard" and color="warning".
standardError .MuiAlert-standardError Styles applied to the root element if variant="standard" and color="error".
outlinedSuccess .MuiAlert-outlinedSuccess Styles applied to the root element if variant="outlined" and color="success".
outlinedInfo .MuiAlert-outlinedInfo Styles applied to the root element if variant="outlined" and color="info".
outlinedWarning .MuiAlert-outlinedWarning Styles applied to the root element if variant="outlined" and color="warning".
outlinedError .MuiAlert-outlinedError Styles applied to the root element if variant="outlined" and color="error".
filledSuccess .MuiAlert-filledSuccess Styles applied to the root element if variant="filled" and color="success".
filledInfo .MuiAlert-filledInfo Styles applied to the root element if variant="filled" and color="info".
filledWarning .MuiAlert-filledWarning Styles applied to the root element if variant="filled" and color="warning".
filledError .MuiAlert-filledError Styles applied to the root element if variant="filled" and color="error".
icon .MuiAlert-icon Styles applied to the icon wrapper element.
message .MuiAlert-message Styles applied to the message wrapper element.
action .MuiAlert-action Styles applied to the action wrapper element if action is provided.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the Paper component are also available. You can take advantage of this behavior to target nested components.

Demos