Snackbar API

API reference docs for the React Snackbar component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Snackbar

Import

import Snackbar from '@mui/material/Snackbar';
// or
import { Snackbar } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
action	node	-	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.
autoHideDuration	number	null	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.
children	element	-	Replace the `SnackbarContent` component.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
ClickAwayListenerProps	object	-	Props applied to the `ClickAwayListener` element.
ContentProps	object	-	Props applied to the `SnackbarContent` element.
disableWindowBlurListener	bool	false	If `true`, the `autoHideDuration` timer will expire even if the window is not focused.
key	any	-	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.
message	node	-	The message to display.
onClose	func	-	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: React.SyntheticEvent \| Event, reason: string) => void` `event` The event source of the callback. `reason` Can be: `"timeout"` (`autoHideDuration` expired), `"clickaway"`, or `"escapeKeyDown"`.
open	bool	-	If `true`, the component is shown.
resumeHideDuration	number	-	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.
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.
TransitionComponent	elementType	Grow	The component used for the transition. Follow this guide to learn more about the requirements for this component.
transitionDuration	number \| { appear?: number, enter?: number, exit?: number }	{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }	The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
TransitionProps	object	{}	Props applied to the transition element. By default, the element is based on this `Transition` component.

The 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.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiSnackbar-anchorOriginBottomCenter	anchorOriginBottomCenter	Styles applied to the root element if `anchorOrigin={{ 'bottom', 'center' }}`.
.MuiSnackbar-anchorOriginBottomLeft	anchorOriginBottomLeft	Styles applied to the root element if `anchorOrigin={{ 'bottom', 'left' }}`.
.MuiSnackbar-anchorOriginBottomRight	anchorOriginBottomRight	Styles applied to the root element if `anchorOrigin={{ 'bottom', 'right' }}`.
.MuiSnackbar-anchorOriginTopCenter	anchorOriginTopCenter	Styles applied to the root element if `anchorOrigin={{ 'top', 'center' }}`.
.MuiSnackbar-anchorOriginTopLeft	anchorOriginTopLeft	Styles applied to the root element if `anchorOrigin={{ 'top', 'left' }}`.
.MuiSnackbar-anchorOriginTopRight	anchorOriginTopRight	Styles applied to the root element if `anchorOrigin={{ 'top', 'right' }}`.
.MuiSnackbar-root	root	Styles applied to the root element.

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 styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.