Alert API
想要学习更多组件属性和 CSS API,可以查阅 React Alert 组件的 API 文档。
导入
import Alert from '@mui/material/Alert';
// 或
import { Alert } from '@mui/material';
组件名称
在主题中,名称“MuiAlert
”可用于提供默认属性(props),或者样式覆盖属性
Paper 组件的属性也是可用的。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
action | node | The action to display. It renders after the message, at the end of the alert. | |
children | node | The content of the component. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
closeText | string | 'Close' | Override the default label for the close popup icon button. For localization purposes, you can use the provided translations. |
color | 'error' | 'info' | 'success' | 'warning' | string | The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. | |
components | { CloseButton?: elementType, CloseIcon?: elementType } | {} | |
componentsProps | { closeButton?: object, closeIcon?: object } | {} | |
icon | node | Override the icon displayed before the children. Unless provided, the icon is mapped to the value of the severity prop. Set to false to remove the icon . | |
iconMapping | { error?: node, info?: node, success?: node, warning?: node } | The component maps the severity prop to a range of different icons, for instance success to <SuccessOutlined> . If you wish to change this mapping, you can provide your own. Alternatively, you can use the icon prop to override the icon displayed. | |
onClose | func | Callback fired when the component requests to be closed. When provided and no action prop is set, a close icon button is displayed that triggers the callback when clicked.Signature: function(event: React.SyntheticEvent) => void event: The event source of the callback. | |
role | string | 'alert' | The ARIA role attribute of the element. |
severity | 'error' | 'info' | 'success' | 'warning' | 'success' | The severity of the alert. This defines the color and icon used. |
slotProps | { closeButton?: object, closeIcon?: object } | {} | |
slots | { closeButton?: elementType, closeIcon?: elementType } | {} | |
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. | |
variant | 'filled' | 'outlined' | 'standard' | string | 'standard' | The variant to use. |
ref
则会被传递到根元素中。继承
尽管上文没有明文记录, Paper 组件 的属性(props) 在组件Alert上同样是可用的。 你可以利用这一点来 指向嵌套组件CSS
规则名称 | 全局类名 | 描述 |
---|---|---|
root | .MuiAlert-root | Styles applied to the root element. |
filled | .MuiAlert-filled | Styles applied to the root element if variant="filled" . |
outlined | .MuiAlert-outlined | Styles applied to the root element if variant="outlined" . |
standard | .MuiAlert-standard | Styles applied to the root element if variant="standard" . |
standardSuccess | .MuiAlert-standardSuccess | Styles applied to the root element if variant="standard" and color="success" . |
standardInfo | .MuiAlert-standardInfo | Styles applied to the root element if variant="standard" and color="info" . |
standardWarning | .MuiAlert-standardWarning | Styles applied to the root element if variant="standard" and color="warning" . |
standardError | .MuiAlert-standardError | Styles applied to the root element if variant="standard" and color="error" . |
outlinedSuccess | .MuiAlert-outlinedSuccess | Styles applied to the root element if variant="outlined" and color="success" . |
outlinedInfo | .MuiAlert-outlinedInfo | Styles applied to the root element if variant="outlined" and color="info" . |
outlinedWarning | .MuiAlert-outlinedWarning | Styles applied to the root element if variant="outlined" and color="warning" . |
outlinedError | .MuiAlert-outlinedError | Styles applied to the root element if variant="outlined" and color="error" . |
filledSuccess | .MuiAlert-filledSuccess | Styles applied to the root element if variant="filled" and color="success" . |
filledInfo | .MuiAlert-filledInfo | Styles applied to the root element if variant="filled" and color="info" . |
filledWarning | .MuiAlert-filledWarning | Styles applied to the root element if variant="filled" and color="warning" . |
filledError | .MuiAlert-filledError | Styles applied to the root element if variant="filled" and color="error" . |
icon | .MuiAlert-icon | Styles applied to the icon wrapper element. |
message | .MuiAlert-message | Styles applied to the message wrapper element. |
action | .MuiAlert-action | Styles applied to the action wrapper element if action is provided. |
您可以使用组件自定义选项对组件进行个性化:
- 具备 全局类名.
- 在自定义主体中,设定一个规则名称作为组件的
styleOverrides
属性的一部分。