Skip to content

ModalDialog API

API reference docs for the React ModalDialog 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 ModalDialog from '@mui/joy/ModalDialog';
// or
import { ModalDialog } from '@mui/joy';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
color'danger'
| 'info'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'
The color of the component. It supports those theme colors that make sense for this component.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
layout'center'
| 'fullscreen'
| string
'center'
The layout of the dialog
size'sm'
| 'md'
| 'lg'
| string
'md'
The size of the component.
sxArray<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.
variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'outlined'
The variant to use.

The ref is forwarded to the root element.