Skip to content
Edit this page

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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

color

The color of the component. It supports those theme colors that make sense for this component.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
endDecorator

Element placed after the children.

Type:

node
invertedColors

If true, the children with an implicit color prop invert their colors to match the component's variant and color.

Type:

bool

Default:

false
role

The ARIA role attribute of the element.

Type:

string

Default:

'alert'
size

The size of the component.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ endDecorator?: func | object, root?: func | object, startDecorator?: func | object }

Default:

{}
slots

The components used for each slot inside.

Type:

{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }

Default:

{}
startDecorator

Element placed before the children.

Type:

node
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'outlined'
The ref is forwarded to the root element.

Theme default props

You can use JoyAlert to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root'div'Required

Global class: .MuiAlert-root

Description: The component that renders the root.

startDecorator'span'Required

Global class: .MuiAlert-startDecorator

Description: The component that renders the start decorator.

endDecorator'span'Required

Global class: .MuiAlert-endDecorator

Description: The component that renders the end decorator.

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

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiAlert-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiAlert-colorDanger

Class name applied to the root element if color="danger".

.MuiAlert-colorNeutral

Class name applied to the root element if color="neutral".

.MuiAlert-colorPrimary

Class name applied to the root element if color="primary".

.MuiAlert-colorSuccess

Class name applied to the root element if color="success".

.MuiAlert-colorWarning

Class name applied to the root element if color="warning".

.MuiAlert-sizeLg

Class name applied to the root element if size="lg".

.MuiAlert-sizeMd

Class name applied to the root element if size="md".

.MuiAlert-sizeSm

Class name applied to the root element if size="sm".

.MuiAlert-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiAlert-variantPlain

Class name applied to the root element if variant="plain".

.MuiAlert-variantSoft

Class name applied to the root element if variant="soft".

.MuiAlert-variantSolid

Class name applied to the root element if variant="solid".