Snackbar API
API reference docs for the React Snackbar component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Snackbar from '@mui/material/Snackbar';
// or
import { Snackbar } from '@mui/material';Props of the native component are also available.
The anchor of the Snackbar. On smaller screens, the component grows to occupy all the available width, the horizontal alignment is ignored.
Type:{ horizontal: 'center'
| 'left'
| 'right', vertical: 'bottom'
| 'top' }
Default:{ vertical: 'bottom', horizontal: 'left' }
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.
Type:number
Default:null
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
If true, the autoHideDuration timer will expire even if the window is not focused.
Type:bool
Default:false
When displaying multiple consecutive snackbars using a single parent-rendered <Snackbar/>, add the key prop to ensure independent treatment of each message. For instance, use <Snackbar key={message} />. Otherwise, messages might update in place, and features like autoHideDuration could be affected.
Type:any
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.
Type:func
function(event: React.SyntheticEvent | Event, reason: string) => void eventThe event source of the callback.reasonCan be:"timeout"(autoHideDurationexpired),"clickaway", or"escapeKeyDown".
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.
Type:number
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
The component used for the transition. Follow this guide to learn more about the requirements for this component.
Type:elementType
Default:Grow
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
Type:number
| { appear?: number, enter?: number, exit?: number }
Default:{
enter: theme.transitions.duration.enteringScreen,
exit: theme.transitions.duration.leavingScreen,
}
Props applied to the transition element. By default, the element is based on this Transition component.
Type:object
Default:{}
ref is forwarded to the root element.Theme default props
You can use MuiSnackbar to change the default props of this component with the theme.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Styles applied to the root element if anchorOrigin={{ 'bottom', 'center' }}.
Rule name:anchorOriginBottomCenter
Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }}.
Rule name:anchorOriginBottomLeft
Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }}.
Rule name:anchorOriginBottomRight
Styles applied to the root element if anchorOrigin={{ 'top', 'center' }}.
Rule name:anchorOriginTopCenter
Styles applied to the root element if anchorOrigin={{ 'top', 'left' }}.
Rule name:anchorOriginTopLeft
Styles applied to the root element if anchorOrigin={{ 'top', 'right' }}.
Rule name:anchorOriginTopRight
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.