Skip to content

Snackbar API

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

Demos

Import

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

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

Props

NameTypeDefaultDescription
open*bool-

If true, the component is shown.

anchorOrigin{ horizontal: 'center'
| 'left'
| 'right', vertical: 'bottom'
| 'top' }
{ vertical: 'bottom', horizontal: 'right' }

The anchor of the Snackbar. On smaller screens, the component grows to occupy all the available width, the horizontal alignment is ignored.

animationDurationnumber300

The duration of the animation in milliseconds. This value is used to control the length of time it takes for an animation to complete one cycle. It is also utilized for delaying the unmount of the component. Provide this value if you have your own animation so that we can precisely time the component's unmount to match your custom animation.

autoHideDurationnumbernull

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.

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
'neutral'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

disableWindowBlurListenerboolfalse

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

endDecoratornode-

Element placed after the children.

invertedColorsboolfalse

If true, the children with an implicit color prop invert their colors to match the component's variant and color.

keyany-

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.

onClosefunc-

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".
onUnmountfunc-

A callback fired when the component is about to be unmounted.

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.

size'sm'
| 'md'
| 'lg'
'md'

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

slotProps{ clickAway?: func
| { children: element, disableReactTree?: bool, mouseEvent?: 'onClick'
| 'onMouseDown'
| 'onMouseUp'
| 'onPointerDown'
| 'onPointerUp'
| false, onClickAway: func, touchEvent?: 'onTouchEnd'
| 'onTouchStart'
| false }, endDecorator?: func
| object, root?: func
| object, startDecorator?: func
| object }
{}

The props used for each slot inside.

slots{ clickAway?: elementType, endDecorator?: elementType, root?: elementType, startDecorator?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

startDecoratornode-

Element placed before the children.

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

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
'outlined'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoySnackbar to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescription
root.MuiSnackbar-root'div'The component that renders the root.
startDecorator.MuiSnackbar-startDecorator'span'The component that renders the start decorator.
endDecorator.MuiSnackbar-endDecorator'span'The component that renders the end decorator.
clickAwayClickAwayListenerThe component that renders the click away.

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 nameRule nameDescription
.MuiSnackbar-anchorOriginBottomCenteranchorOriginBottomCenterStyles applied to the root element if anchorOrigin={{ 'bottom', 'center' }}.
.MuiSnackbar-anchorOriginBottomLeftanchorOriginBottomLeftStyles applied to the root element if anchorOrigin={{ 'bottom', 'left' }}.
.MuiSnackbar-anchorOriginBottomRightanchorOriginBottomRightStyles applied to the root element if anchorOrigin={{ 'bottom', 'right' }}.
.MuiSnackbar-anchorOriginTopCenteranchorOriginTopCenterStyles applied to the root element if anchorOrigin={{ 'top', 'center' }}.
.MuiSnackbar-anchorOriginTopLeftanchorOriginTopLeftStyles applied to the root element if anchorOrigin={{ 'top', 'left' }}.
.MuiSnackbar-anchorOriginTopRightanchorOriginTopRightStyles applied to the root element if anchorOrigin={{ 'top', 'right' }}.
.MuiSnackbar-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiSnackbar-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiSnackbar-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiSnackbar-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiSnackbar-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiSnackbar-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiSnackbar-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiSnackbar-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiSnackbar-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiSnackbar-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiSnackbar-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiSnackbar-variantSolidvariantSolidClass name applied to the root element if variant="solid".

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

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.