Skip to content

Alert API

API reference docs for the React Alert component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
color'danger'
| 'info'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'primary'
The color of the component. It supports those theme colors that make sense for this component.
endDecoratornode
Element placed after the children.
rolestring'alert'
The ARIA role attribute of the element.
size'sm'
| 'md'
| 'lg'
| string
'md'
The size of the component.
startDecoratornode
Element placed before the children.
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'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'soft'
The variant to use.

The ref is forwarded to the root element.