Skip to content
Edit this page

Dialog API

API documentation for the React Dialog component. Learn about the available props and the CSS API.

Import

import Dialog from '@mui/material/Dialog';
// or
import { Dialog } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Dialogs are overlaid modal paper based components with a backdrop.

Component name

The name MuiDialog can be used when providing default props or style overrides in the theme.

Props

Props of the Modal component are also available.

NameTypeDefaultDescription
open*boolfalse
If true, the component is shown.
aria-describedbystring
The id(s) of the element(s) that describe the dialog.
aria-labelledbystring
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.
childrennode
Dialog children, usually the included sub-components.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
disableEscapeKeyDownboolfalse
If true, hitting escape will not fire the onClose callback.
fullScreenboolfalse
If true, the dialog is full-screen.
fullWidthboolfalse
If true, the dialog stretches to maxWidth.
Notice that the dialog width grow is limited by the default margin.
maxWidth'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| false
| string		'sm'
Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.
onBackdropClickfunc
Callback fired when the backdrop is clicked.
onClosefunc
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".
PaperComponentelementTypePaper
The component used to render the body of the dialog.
PaperPropsobject{}
Props applied to the Paper element.
scroll'body'
| 'paper'		'paper'
Determine the container for scrolling the dialog.
sxfunc
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
TransitionComponentelementTypeFade
The component used for the transition. Follow this guide to learn more about the requirements for this component.
transitionDurationnumber
| { appear?: number, enter?: number, exit?: number }		{ enter: duration.enteringScreen, exit: duration.leavingScreen }
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
TransitionPropsobject
Props applied to the transition element. By default, the element is based on this Transition component.

The ref is forwarded to the root element.

Inheritance

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

CSS

Rule nameGlobal classDescription
root.MuiDialog-rootStyles applied to the root element.
scrollPaper.MuiDialog-scrollPaperStyles applied to the container element if scroll="paper".
scrollBody.MuiDialog-scrollBodyStyles applied to the container element if scroll="body".
container.MuiDialog-containerStyles applied to the container element.
paper.MuiDialog-paperStyles applied to the Paper component.
paperScrollPaper.MuiDialog-paperScrollPaperStyles applied to the Paper component if scroll="paper".
paperScrollBody.MuiDialog-paperScrollBodyStyles applied to the Paper component if scroll="body".
paperWidthFalse.MuiDialog-paperWidthFalseStyles applied to the Paper component if maxWidth=false.
paperWidthXs.MuiDialog-paperWidthXsStyles applied to the Paper component if maxWidth="xs".
paperWidthSm.MuiDialog-paperWidthSmStyles applied to the Paper component if maxWidth="sm".
paperWidthMd.MuiDialog-paperWidthMdStyles applied to the Paper component if maxWidth="md".
paperWidthLg.MuiDialog-paperWidthLgStyles applied to the Paper component if maxWidth="lg".
paperWidthXl.MuiDialog-paperWidthXlStyles applied to the Paper component if maxWidth="xl".
paperFullWidth.MuiDialog-paperFullWidthStyles applied to the Paper component if fullWidth={true}.
paperFullScreen.MuiDialog-paperFullScreenStyles applied to the Paper component if fullScreen={true}.

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

Demos