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.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

Props of the Modal component are also available.

openRequired

aria-describedby

aria-labelledby

BackdropComponent

children

classes

disableEscapeKeyDown

fullScreen

fullWidth

maxWidth

onBackdropClick

onClose

PaperComponent

PaperProps

scroll

sx

TransitionComponent

transitionDuration

TransitionProps

The ref is forwarded to the root element.

Inheritance

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiDialog-root

.MuiDialog-scrollPaper

.MuiDialog-scrollBody

.MuiDialog-container

.MuiDialog-paper

.MuiDialog-paperScrollPaper

.MuiDialog-paperScrollBody

.MuiDialog-paperWidthFalse

.MuiDialog-paperWidthXs

.MuiDialog-paperWidthSm

.MuiDialog-paperWidthMd

.MuiDialog-paperWidthLg

.MuiDialog-paperWidthXl

.MuiDialog-paperFullWidth

.MuiDialog-paperFullScreen


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