ChatMessageError API
API reference docs for the React ChatMessageError component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import { ChatMessageError } from '@mui/x-chat/ChatMessageError';
// or
import { ChatMessageError } from '@mui/x-chat';Learn about the difference by reading this guide on minimizing bundle size.
Props of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| children | node | - | The content of the component. |
| classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
| slotProps | object | {} | The props used for each component slot. |
| slots | object | {} | Overridable component slots. See Slots API below for more details. |
| 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. |
| Slot name | Class name | Default component | Description |
|---|---|---|---|
| root | .MuiChatMessageError-root | The root element of the per-message error primitive. Rendered with role="alert" so screen readers announce the error. |
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
| Class name | Rule name | Description |
|---|---|---|
| .MuiChatMessageError-message | message | Styles applied to the message text element. |
| .MuiChatMessageError-retryButton | retryButton | Styles applied to the retry button. |
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.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.