Skip to content
Edit this page

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:

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.

action

The action to display. It renders after the message, at the end of the snackbar.

Type:

node
anchorOrigin

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' }
autoHideDuration

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
children

Replace the SnackbarContent component.

Type:

element
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
ClickAwayListenerProps

Props applied to the ClickAwayListener element.

Type:

object
ContentProps

Props applied to the SnackbarContent element.

Type:

object
disableWindowBlurListener

If true, the autoHideDuration timer will expire even if the window is not focused.

Type:

bool

Default:

false
key

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
message

The message to display.

Type:

node
onClose

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

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

If true, the component is shown.

Type:

bool
resumeHideDuration

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
sx

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
TransitionComponent

The component used for the transition. Follow this guide to learn more about the requirements for this component.

Type:

elementType

Default:

Grow
transitionDuration

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, }
TransitionProps

Props applied to the transition element. By default, the element is based on this Transition component.

Type:

object

Default:

{}
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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiSnackbar-rootroot

Styles applied to the root element.

.MuiSnackbar-anchorOriginTopCenteranchorOriginTopCenter

Styles applied to the root element if anchorOrigin={{ 'top', 'center' }}.

.MuiSnackbar-anchorOriginBottomCenteranchorOriginBottomCenter

Styles applied to the root element if anchorOrigin={{ 'bottom', 'center' }}.

.MuiSnackbar-anchorOriginTopRightanchorOriginTopRight

Styles applied to the root element if anchorOrigin={{ 'top', 'right' }}.

.MuiSnackbar-anchorOriginBottomRightanchorOriginBottomRight

Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }}.

.MuiSnackbar-anchorOriginTopLeftanchorOriginTopLeft

Styles applied to the root element if anchorOrigin={{ 'top', 'left' }}.

.MuiSnackbar-anchorOriginBottomLeftanchorOriginBottomLeft

Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }}.

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