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';Component name
The nameMuiAlert can be used when providing default props or style overrides in the theme.Props
Props of the Paper component are also available.
| 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' | 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. This prop is an alias for the slots prop. It's recommended to use the slots prop instead. |
| componentsProps | { closeButton?: object, closeIcon?: object } | {} | The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future. |
| icon | node | 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. | |
| 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: React.SyntheticEvent) => voidevent: 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. |
| slotProps | { closeButton?: object, closeIcon?: object } | {} | The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the componentsProps prop, which will be deprecated in the future. |
| slots | { closeButton?: elementType, closeIcon?: elementType } | {} | The components used for each slot inside. This prop is an alias for the components prop, which will be deprecated in the future. |
| sx | Array<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 name | Global class | Description |
|---|---|---|
| root | .MuiAlert-root | Styles applied to the root element. |
| filled | .MuiAlert-filled | Styles applied to the root element if variant="filled". |
| outlined | .MuiAlert-outlined | Styles applied to the root element if variant="outlined". |
| standard | .MuiAlert-standard | Styles applied to the root element if variant="standard". |
| 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 using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.