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. To learn how to add your own colors, check out Themed components—Extend colors.
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. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Slots

NameDefault classDefault HTML tagDescription
root.MuiAlert-root'div'The component that renders the root. To learn how to customize the slot, check out the Overriding component structure guide.
startDecorator.MuiAlert-startDecorator'span'The component that renders the start decorator. To learn how to customize the slot, check out the Overriding component structure guide.
endDecorator.MuiAlert-endDecorator'span'The component that renders the end decorator. To learn how to customize the slot, check out the Overriding component structure guide.