SnackbarAPI
React Snackbar 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。
演示
导入
import Snackbar from '@mui/joy/Snackbar';
// or
import { Snackbar } from '@mui/joy';
要了解差异,请阅读关于最小化捆绑包大小的指南。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
open* | bool | - | 如果为 |
anchorOrigin | { horizontal: 'center' | 'left' | 'right', vertical: 'bottom' | 'top' } | { vertical: 'bottom', horizontal: 'right' } |
|
animationDuration | number | 300 | 动画的持续时间,以毫秒为单位。此值用于控制动画完成一个周期所需的时间长度。它也用于延迟组件的卸载。如果您有自己的动画,请提供此值,以便我们可以精确地定时组件的卸载以匹配您的自定义动画。 |
autoHideDuration | number | null | 在自动调用 |
color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | 'neutral' | 组件的颜色。它支持那些对此组件有意义的主题颜色。 要了解如何添加自己的颜色,请查看主题组件—扩展颜色。 |
component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串或组件。 |
disableWindowBlurListener | bool | false | 如果为 |
endDecorator | node | - | 放置在子元素之后的元素。 |
invertedColors | bool | false | 如果为 |
key | any | - | 当使用单个父级渲染的 |
onClose | func | - | 当组件请求关闭时触发的回调。通常 签名: function(event: React.SyntheticEvent<any> | Event, reason: string) => void
|
onUnmount | func | - | 组件即将卸载时触发的回调。 |
resumeHideDuration | number | - | 在用户交互后等待多少毫秒才关闭。如果未指定 |
size | 'sm' | 'md' | 'lg' | 'md' | 组件的大小。 要了解如何向组件添加自定义尺寸,请查看主题组件—扩展尺寸。 |
slotProps | { clickAway?: func | { children: element, disableReactTree?: bool, mouseEvent?: 'onClick' | 'onMouseDown' | 'onMouseUp' | 'onPointerDown' | 'onPointerUp' | false, onClickAway: func, touchEvent?: 'onTouchEnd' | 'onTouchStart' | false }, endDecorator?: func | object, root?: func | object, startDecorator?: func | object } | {} | 用于每个 slot 内部的 props。 |
slots | { clickAway?: elementType, endDecorator?: elementType, root?: elementType, startDecorator?: elementType } | {} | 用于每个 slot 内部的组件。 有关更多详细信息,请参见下面的Slots API。 |
startDecorator | node | - | 放置在子元素之前的元素。 |
sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统 prop。 有关更多详细信息,请参见`sx` 页面。 |
variant | 'outlined' | 'plain' | 'soft' | 'solid' | 'outlined' | 要使用的全局 variant。 要了解如何添加自己的 variant,请查看主题组件—扩展 variant。 |
ref
被转发到根元素。主题默认 props
您可以使用 JoySnackbar
通过主题更改此组件的默认 props。
要了解如何自定义 slot,请查看覆盖组件结构指南。
Slot 名称 | 类名 | 默认组件 | 描述 |
---|---|---|---|
root | .MuiSnackbar-root | 'div' | 渲染根元素的组件。 |
startDecorator | .MuiSnackbar-startDecorator | 'span' | 渲染 start decorator 的组件。 |
endDecorator | .MuiSnackbar-endDecorator | 'span' | 渲染 end decorator 的组件。 |
clickAway | ClickAwayListener | 渲染 click away 的组件。 |
这些类名对于使用 CSS 设置样式很有用。当触发特定状态时,它们会应用于组件的 slot。
类名 | 规则名称 | 描述 |
---|---|---|
.MuiSnackbar-anchorOriginBottomCenter | anchorOriginBottomCenter | 如果 anchorOrigin={{ 'bottom', 'center' }} ,则应用于根元素的样式。 |
.MuiSnackbar-anchorOriginBottomLeft | anchorOriginBottomLeft | 如果 anchorOrigin={{ 'bottom', 'left' }} ,则应用于根元素的样式。 |
.MuiSnackbar-anchorOriginBottomRight | anchorOriginBottomRight | 如果 anchorOrigin={{ 'bottom', 'right' }} ,则应用于根元素的样式。 |
.MuiSnackbar-anchorOriginTopCenter | anchorOriginTopCenter | 如果 anchorOrigin={{ 'top', 'center' }} ,则应用于根元素的样式。 |
.MuiSnackbar-anchorOriginTopLeft | anchorOriginTopLeft | 如果 anchorOrigin={{ 'top', 'left' }} ,则应用于根元素的样式。 |
.MuiSnackbar-anchorOriginTopRight | anchorOriginTopRight | 如果 anchorOrigin={{ 'top', 'right' }} ,则应用于根元素的样式。 |
.MuiSnackbar-colorDanger | colorDanger | 如果 color="danger" ,则应用于根元素的类名。 |
.MuiSnackbar-colorNeutral | colorNeutral | 如果 color="neutral" ,则应用于根元素的类名。 |
.MuiSnackbar-colorPrimary | colorPrimary | 如果 color="primary" ,则应用于根元素的类名。 |
.MuiSnackbar-colorSuccess | colorSuccess | 如果 color="success" ,则应用于根元素的类名。 |
.MuiSnackbar-colorWarning | colorWarning | 如果 color="warning" ,则应用于根元素的类名。 |
.MuiSnackbar-sizeLg | sizeLg | 如果 size="lg" ,则应用于根元素的类名。 |
.MuiSnackbar-sizeMd | sizeMd | 如果 size="md" ,则应用于根元素的类名。 |
.MuiSnackbar-sizeSm | sizeSm | 如果 size="sm" ,则应用于根元素的类名。 |
.MuiSnackbar-variantOutlined | variantOutlined | 如果 variant="outlined" ,则应用于根元素的类名。 |
.MuiSnackbar-variantPlain | variantPlain | 如果 variant="plain" ,则应用于根元素的类名。 |
.MuiSnackbar-variantSoft | variantSoft | 如果 variant="soft" ,则应用于根元素的类名。 |
.MuiSnackbar-variantSolid | variantSolid | 如果 variant="solid" ,则应用于根元素的类名。 |
您可以使用以下自定义选项之一覆盖组件的样式
- 使用全局类名。
- 使用规则名称作为自定义主题中组件的
styleOverrides
属性的一部分。
源代码
如果您在此页面中找不到所需的信息,请考虑查看组件的实现以获取更多详细信息。