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.

Component demos

Import

import Modal from '@mui/joy/Modal';
// or
import { Modal } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
The ref is forwarded to the root element.

Slots

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

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: