跳转到内容

Snackbar API

API documentation for the React Snackbar component. Learn about the available props, and the CSS API.

Import

import Snackbar from '@mui/material/Snackbar';
// 或
import { Snackbar } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiSnackbar can be used when providing default props or style overrides in the theme.

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
actionnode
The action to display. It renders after the message, at the end of the snackbar.
anchorOrigin{ horizontal: 'center'
| 'left'
| 'right', vertical: 'bottom'
| 'top' }
{ vertical: 'bottom', horizontal: 'left' }
The anchor of the Snackbar. On smaller screens, the component grows to occupy all the available width, the horizontal alignment is ignored.
autoHideDurationnumbernull
The number of milliseconds to wait before automatically calling the onClose function. onClose should then set the state of the open prop to hide the Snackbar. This behavior is disabled by default with the null value.
childrenelement
Replace the SnackbarContent component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
ClickAwayListenerPropsobject
Props applied to the ClickAwayListener element.
ContentPropsobject
Props applied to the SnackbarContent element.
disableWindowBlurListenerboolfalse
If true, the autoHideDuration timer will expire even if the window is not focused.
keyany
When displaying multiple consecutive Snackbars from a parent rendering a single <Snackbar/>, add the key prop to ensure independent treatment of each message. e.g. <Snackbar key={message} />, otherwise, the message may update-in-place and features such as autoHideDuration may be canceled.
messagenode
The message to display.
onClosefunc
Callback fired when the component requests to be closed. Typically onClose is used to set state in the parent component, which is used to control the Snackbar open prop. The reason parameter can optionally be used to control the response to onClose, for example ignoring clickaway.

Signature:
function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be: "timeout" (autoHideDuration expired), "clickaway".
openboolfalse
Control the popup` open state.
resumeHideDurationnumber
The number of milliseconds to wait before dismissing after user interaction. If autoHideDuration prop isn't specified, it does nothing. If autoHideDuration prop is specified but resumeHideDuration isn't, we default to autoHideDuration / 2 ms.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
TransitionComponentelementTypeGrow
The component used for the transition. Follow this guide to learn more about the requirements for this component.
transitionDurationnumber
| { appear?: number, enter?: number, exit?: number }
{ enter: duration.enteringScreen, exit: duration.leavingScreen, }
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
TransitionPropsobject{}
Props applied to the transition element. By default, the element is based on this Transition component.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiSnackbar-rootStyles applied to the root element.
anchorOriginTopCenter.MuiSnackbar-anchorOriginTopCenterStyles applied to the root element if anchorOrigin={{ 'top', 'center' }}.
anchorOriginBottomCenter.MuiSnackbar-anchorOriginBottomCenterStyles applied to the root element if anchorOrigin={{ 'bottom', 'center' }}.
anchorOriginTopRight.MuiSnackbar-anchorOriginTopRightStyles applied to the root element if anchorOrigin={{ 'top', 'right' }}.
anchorOriginBottomRight.MuiSnackbar-anchorOriginBottomRightStyles applied to the root element if anchorOrigin={{ 'bottom', 'right' }}.
anchorOriginTopLeft.MuiSnackbar-anchorOriginTopLeftStyles applied to the root element if anchorOrigin={{ 'top', 'left' }}.
anchorOriginBottomLeft.MuiSnackbar-anchorOriginBottomLeftStyles applied to the root element if anchorOrigin={{ 'bottom', 'left' }}.

You can override the style of the component using one of these customization options:

Demos