Skip to content
+

Snackbar

The Snackbar component informs users that an action has been or will be performed by the app.

useSnackbar API

Import

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

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

Parameters

NameTypeDefaultDescription
autoHideDurationnumber | nullnull

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.

disableWindowBlurListenerbooleanfalse

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

onClose(event: React.SyntheticEvent<any> | Event | null, reason: SnackbarCloseReason) => void-

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.

openboolean-

If true, the component is shown.

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.

Return value

NameTypeDescription
getRootProps<ExternalProps extends Record<string, unknown> = {}>(externalProps?: ExternalProps) => UseSnackbarRootSlotProps<ExternalProps>

Resolver for the root slot's props.

onClickAway(event: React.SyntheticEvent<any> | Event) => void

Callback fired when a "click away" event is detected.