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:

Dialog

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.

Name	Type	Default	Description
open*	bool	-	If `true`, the component is shown.
aria-describedby	string	-	The id(s) of the element(s) that describe the dialog.
aria-labelledby	string	-	The id(s) of the element(s) that label the dialog.
aria-modal	'false' \| 'true' \| bool	true	Informs assistive technologies that the element is modal. It's added on the element with role="dialog".
BackdropComponent	elementType	styled(Backdrop, { name: 'MuiModal', slot: 'Backdrop', overridesResolver: (props, styles) => { return styles.backdrop; }, })({ zIndex: -1, })	A backdrop component. This prop enables custom backdrop rendering. Deprecated－Use `slots.backdrop` instead. While this prop currently works, it will be removed in the next major version.
children	node	-	Dialog children, usually the included sub-components.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disableEscapeKeyDown	bool	false	If `true`, hitting escape will not fire the `onClose` callback.
fullScreen	bool	false	If `true`, the dialog is full-screen.
fullWidth	bool	false	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`.
onBackdropClick	func	-	Callback fired when the backdrop is clicked. Deprecated－Use the `onClose` prop with the `reason` argument to handle the `backdropClick` events.
onClose	func	-	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"`.
PaperComponent	elementType	Paper	The component used to render the body of the dialog.
PaperProps	object	{}	Props applied to the `Paper` element.
scroll	'body' \| 'paper'	'paper'	Determine the container for scrolling the dialog.
sx	Array<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.
TransitionComponent	elementType	Fade	The component used for the transition. Follow this guide to learn more about the requirements for this component.
transitionDuration	number \| { 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.
TransitionProps	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.

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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiDialog-container	container	Styles applied to the container element.
.MuiDialog-paper	paper	Styles applied to the Paper component.
.MuiDialog-paperFullScreen	paperFullScreen	Styles applied to the Paper component if `fullScreen={true}`.
.MuiDialog-paperFullWidth	paperFullWidth	Styles applied to the Paper component if `fullWidth={true}`.
.MuiDialog-paperScrollBody	paperScrollBody	Styles applied to the Paper component if `scroll="body"`.
.MuiDialog-paperScrollPaper	paperScrollPaper	Styles applied to the Paper component if `scroll="paper"`.
.MuiDialog-paperWidthFalse	paperWidthFalse	Styles applied to the Paper component if `maxWidth=false`.
.MuiDialog-paperWidthLg	paperWidthLg	Styles applied to the Paper component if `maxWidth="lg"`.
.MuiDialog-paperWidthMd	paperWidthMd	Styles applied to the Paper component if `maxWidth="md"`.
.MuiDialog-paperWidthSm	paperWidthSm	Styles applied to the Paper component if `maxWidth="sm"`.
.MuiDialog-paperWidthXl	paperWidthXl	Styles applied to the Paper component if `maxWidth="xl"`.
.MuiDialog-paperWidthXs	paperWidthXs	Styles applied to the Paper component if `maxWidth="xs"`.
.MuiDialog-root	root	Styles applied to the root element.
.MuiDialog-scrollBody	scrollBody	Styles applied to the container element if `scroll="body"`.
.MuiDialog-scrollPaper	scrollPaper	Styles applied to the container element if `scroll="paper"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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.