Dialog API
API reference docs for the React Dialog component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Dialog from '@mui/material/Dialog';
// or
import { Dialog } from '@mui/material';Dialogs are overlaid modal paper based components with a backdrop.
Props of the Modal component are also available.
A backdrop component. This prop enables custom backdrop rendering.
Type:elementType
Default:styled(Backdrop, {
name: 'MuiModal',
slot: 'Backdrop',
overridesResolver: (props, styles) => {
return styles.backdrop;
},
})({
zIndex: -1,
})
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
If true, hitting escape will not fire the onClose callback.
Type:bool
Default:false
If true, the dialog stretches to maxWidth.
Notice that the dialog width grow is limited by the default margin.
Type:bool
Default:false
Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.
Type:'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| false
| string
Default:'sm'
Callback fired when the component requests to be closed.
Type:func
function(event: object, reason: string) => voideventThe event source of the callback.reasonCan be:"escapeKeyDown","backdropClick".
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
The component used for the transition. Follow this guide to learn more about the requirements for this component.
Type:elementType
Default:Fade
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
Type:number
| { appear?: number, enter?: number, exit?: number }
Default:{
enter: theme.transitions.duration.enteringScreen,
exit: theme.transitions.duration.leavingScreen,
}
Props applied to the transition element. By default, the element is based on this Transition component.
Type:object
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Styles applied to the Paper component if fullScreen={true}.
Rule name:paperFullScreen
Styles applied to the Paper component if fullWidth={true}.
Rule name:paperFullWidth
Styles applied to the Paper component if scroll="body".
Rule name:paperScrollBody
Styles applied to the Paper component if scroll="paper".
Rule name:paperScrollPaper
Styles applied to the Paper component if maxWidth=false.
Rule name:paperWidthFalse
Styles applied to the Paper component if maxWidth="lg".
Rule name:paperWidthLg
Styles applied to the Paper component if maxWidth="md".
Rule name:paperWidthMd
Styles applied to the Paper component if maxWidth="sm".
Rule name:paperWidthSm
Styles applied to the Paper component if maxWidth="xl".
Rule name:paperWidthXl
Styles applied to the Paper component if maxWidth="xs".
Rule name:paperWidthXs
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
styleOverridesproperty in a custom theme.