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:

Modal

Import

import ModalDialog from '@mui/joy/ModalDialog';
// or
import { ModalDialog } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

children

The content of the component.

Type:

node

color

The color of the component. It supports those theme colors that make sense for this component.

Type:

Default:

'neutral'

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType

layout

The layout of the dialog

Type:

'center' | 'fullscreen' | string

Default:

'center'

size

The size of the component.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'

slotProps

The props used for each slot inside.

Type:

{ root?: func | object }

Default:

{}

slots

The components used for each slot inside.

Type:

{ root?: elementType }

Default:

{}

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object

variant

The global variant to use.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'outlined'

The ref is forwarded to the root element.

Theme default props

You can use JoyModalDialog to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root'div'Required

Global class: .MuiModalDialog-root

Description: The component that renders the root.

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.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiModalDialog-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiModalDialog-colorDanger

Class name applied to the root element if color="danger".

.MuiModalDialog-colorNeutral

Class name applied to the root element if color="neutral".

.MuiModalDialog-colorPrimary

Class name applied to the root element if color="primary".

.MuiModalDialog-colorSuccess

Class name applied to the root element if color="success".

.MuiModalDialog-colorWarning

Class name applied to the root element if color="warning".

.MuiModalDialog-layoutCenter

Class name applied to the root element if layout="center".

.MuiModalDialog-layoutFullscreen

Class name applied to the root element if layout="fullscreen".

.MuiModalDialog-sizeLg

Class name applied to the root element if size="lg".

.MuiModalDialog-sizeMd

Class name applied to the root element if size="md".

.MuiModalDialog-sizeSm

Class name applied to the root element if size="sm".

.MuiModalDialog-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiModalDialog-variantPlain

Class name applied to the root element if variant="plain".

.MuiModalDialog-variantSoft

Class name applied to the root element if variant="soft".

.MuiModalDialog-variantSolid

Class name applied to the root element if variant="solid".

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.