跳到主要内容跳到主要内容

AlertAPI

React Alert 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。

演示

Import

import Alert from '@mui/joy/Alert';
// or
import { Alert } from '@mui/joy';

通过阅读关于最小化 bundle size 的指南,了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型默认值描述
color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'

组件的颜色。它支持对该组件有意义的那些主题颜色。

要了解如何添加您自己的颜色,请查看主题组件—扩展颜色

componentelementType-

用于根节点的组件。可以是用于 HTML 元素的字符串或组件。

endDecoratornode-

放置在子元素之后的元素。

invertedColorsboolfalse

如果为 true,则具有隐式 color prop 的子元素会反转其颜色以匹配组件的 variant 和 color。

rolestring'alert'

元素的 ARIA role 属性。

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

组件的尺寸。

要了解如何向组件添加自定义尺寸,请查看主题组件—扩展尺寸

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

用于每个内部 slot 的 props。

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

用于每个内部 slot 的组件。

有关更多详细信息,请参见下面的Slots API

startDecoratornode-

放置在子元素之前的元素。

sxArray<func
| object
| bool>
| func
| object
-

允许定义系统 overrides 以及其他 CSS 样式的系统 prop。

有关更多详细信息,请参见 `sx` 页面

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

要使用的全局 variant

要了解如何添加您自己的 variants,请查看主题组件—扩展 variants

ref 被转发到根元素。

主题默认 props

您可以使用 JoyAlert 通过主题更改此组件的默认 props。

Slots

要了解如何自定义 slot,请查看覆盖组件结构指南。

Slot 名称类名默认组件描述
root.MuiAlert-root'div'渲染根元素的组件。
startDecorator.MuiAlert-startDecorator'span'渲染 start decorator 的组件。
endDecorator.MuiAlert-endDecorator'span'渲染 end decorator 的组件。

CSS 类

这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时,它们将应用于组件的 slots。

类名规则名称描述
.MuiAlert-colorContextcolorContext当触发颜色反转时,应用于根元素的类名。
.MuiAlert-colorDangercolorDanger如果 color="danger",则应用于根元素的类名。
.MuiAlert-colorNeutralcolorNeutral如果 color="neutral",则应用于根元素的类名。
.MuiAlert-colorPrimarycolorPrimary如果 color="primary",则应用于根元素的类名。
.MuiAlert-colorSuccesscolorSuccess如果 color="success",则应用于根元素的类名。
.MuiAlert-colorWarningcolorWarning如果 color="warning",则应用于根元素的类名。
.MuiAlert-sizeLgsizeLg如果 size="lg",则应用于根元素的类名。
.MuiAlert-sizeMdsizeMd如果 size="md",则应用于根元素的类名。
.MuiAlert-sizeSmsizeSm如果 size="sm",则应用于根元素的类名。
.MuiAlert-variantOutlinedvariantOutlined如果 variant="outlined",则应用于根元素的类名。
.MuiAlert-variantPlainvariantPlain如果 variant="plain",则应用于根元素的类名。
.MuiAlert-variantSoftvariantSoft如果 variant="soft",则应用于根元素的类名。
.MuiAlert-variantSolidvariantSolid如果 variant="solid",则应用于根元素的类名。

您可以使用以下自定义选项之一来覆盖组件的样式

源代码

如果您在此页面中找不到所需的信息,请考虑查看组件的实现以获取更多详细信息。