SnackbarUnstyled API

API reference docs for the React SnackbarUnstyled 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:

Unstyled Snackbar

Import

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

You can 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
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.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
disableWindowBlurListener	bool	false	If `true`, the `autoHideDuration` timer will expire even if the window is not focused.
exited	bool	true	The prop used to handle exited transition and unmount the component.
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<any> \| Event, reason: string) => void` event: The event source of the callback. reason: Can be: `"timeout"` (`autoHideDuration` expired), `"clickaway"`, or `"escapeKeyDown"`.
open	bool	false	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.
slotProps	{ clickAwayListener?: func \| { children: element, disableReactTree?: bool, mouseEvent?: 'onClick' \| 'onMouseDown' \| 'onMouseUp' \| 'onPointerDown' \| 'onPointerUp' \| false, onClickAway?: func, touchEvent?: 'onTouchEnd' \| 'onTouchStart' \| false }, root?: func \| object }	{}	The props used for each slot inside the Snackbar.
slots	{ root?: elementType }	{}	The components used for each slot inside the Snackbar. Either a string to use a HTML element or a component.

The ref is forwarded to the root element.