Skip to content

Dialog API

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



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

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

Dialogs are overlaid modal paper based components with a backdrop.


Props of the Modal component are also available.


If true, the component is shown.


The id(s) of the element(s) that describe the dialog.


The id(s) of the element(s) that label the dialog.

BackdropComponentelementTypestyled(Backdrop, { name: 'MuiModal', slot: 'Backdrop', overridesResolver: (props, styles) => { return styles.backdrop; }, })({ zIndex: -1, })

A backdrop component. This prop enables custom backdrop rendering.


Dialog children, usually the included sub-components.


Override or extend the styles applied to the component.

See CSS classes API below for more details.


If true, hitting escape will not fire the onClose callback.


If true, the dialog is full-screen.


If true, the dialog stretches to maxWidth.
Notice that the dialog width grow is limited by the default margin.

| 'sm'
| 'md'
| 'lg'
| 'xl'
| false
| string

Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.


Callback fired when the backdrop is clicked.


Callback fired when the component requests to be closed.

Signature:function(event: object, reason: string) => void
  • event The event source of the callback.
  • reason Can be: "escapeKeyDown", "backdropClick".

The component used to render the body of the dialog.


Props applied to the Paper element.

| 'paper'

Determine the container for scrolling the dialog.

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


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

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


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

The ref is forwarded to the root element.


While not explicitly documented above, the props of the Modal component are also available in Dialog. You can take advantage of this to target nested components.

Theme default props

You can use MuiDialog 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 nameRule nameDescription
.MuiDialog-containercontainerStyles applied to the container element.
.MuiDialog-paperpaperStyles applied to the Paper component.
.MuiDialog-paperFullScreenpaperFullScreenStyles applied to the Paper component if fullScreen={true}.
.MuiDialog-paperFullWidthpaperFullWidthStyles applied to the Paper component if fullWidth={true}.
.MuiDialog-paperScrollBodypaperScrollBodyStyles applied to the Paper component if scroll="body".
.MuiDialog-paperScrollPaperpaperScrollPaperStyles applied to the Paper component if scroll="paper".
.MuiDialog-paperWidthFalsepaperWidthFalseStyles applied to the Paper component if maxWidth=false.
.MuiDialog-paperWidthLgpaperWidthLgStyles applied to the Paper component if maxWidth="lg".
.MuiDialog-paperWidthMdpaperWidthMdStyles applied to the Paper component if maxWidth="md".
.MuiDialog-paperWidthSmpaperWidthSmStyles applied to the Paper component if maxWidth="sm".
.MuiDialog-paperWidthXlpaperWidthXlStyles applied to the Paper component if maxWidth="xl".
.MuiDialog-paperWidthXspaperWidthXsStyles applied to the Paper component if maxWidth="xs".
.MuiDialog-rootrootStyles applied to the root element.
.MuiDialog-scrollBodyscrollBodyStyles applied to the container element if scroll="body".
.MuiDialog-scrollPaperscrollPaperStyles applied to the container element if scroll="paper".

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