Skip to content

Modal API

API reference docs for the React Modal component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import Modal from '@mui/material/Modal';
// or
import { Modal } from '@mui/material';

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



Modal is a lower-level construct that is leveraged by the following components:

If you are creating a modal dialog, you probably want to use the Dialog component rather than directly using Modal.

This component shares many concepts with react-overlays.

Props

Props of the native component are also available.

NameTypeDefaultDescription
The ref is forwarded to the root element.

Slots

Slot nameClass nameDefault componentDescription

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 nameRule nameDescription

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

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.