跳到内容
🚀 影响 MUI Base 2025 年路线图！参与最新的开发者调查
+

Snackbar

Snackbar 组件用于通知用户应用程序已执行或将要执行的操作。

useSnackbar API

导入

import { useSnackbar } from '@mui/base/useSnackbar';
// or
import { useSnackbar } from '@mui/base';

通过阅读关于最小化包大小的指南，了解更多差异。

参数

名称类型默认值描述
autoHideDurationnumber | nullnull

等待自动调用 onClose 函数的毫秒数。onClose 应该设置 open prop 的状态以隐藏 Snackbar。默认情况下，此行为被禁用，值为 null。

disableWindowBlurListenerbooleanfalse

如果为 true，即使窗口未聚焦，autoHideDuration 定时器也会过期。

onClose(event: React.SyntheticEvent<any> | Event | null, reason: SnackbarCloseReason) => void-

当组件请求关闭时触发的回调函数。通常 onClose 用于在父组件中设置状态，该状态用于控制 Snackbar 的 open prop。reason 参数可以选择性地用于控制对 onClose 的响应，例如忽略 clickaway。

openboolean-

如果为 true，则显示组件。

resumeHideDurationnumber-

用户交互后等待多少毫秒才关闭。如果未指定 autoHideDuration prop，则不起作用。如果指定了 autoHideDuration prop 但未指定 resumeHideDuration，则默认值为 autoHideDuration / 2 毫秒。

返回值

名称类型描述
getRootProps<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSnackbarRootSlotProps<ExternalProps>

根插槽 props 的解析器。

onClickAway(event: React.SyntheticEvent<any> | Event) => void

当检测到“点击外部”事件时触发的回调函数。