{
"props": {
"children": { "type": { "name": "custom", "description": "element" }, "required": true },
"open": { "type": { "name": "bool" }, "required": true },
"BackdropComponent": {
"type": { "name": "elementType" },
"default": "styled(Backdrop, {\n name: 'MuiModal',\n slot: 'Backdrop',\n})({\n zIndex: -1,\n})",
"deprecated": true,
"deprecationInfo": "Use slots.backdrop instead. While this prop currently works, it will be removed in the next major version."
},
"BackdropProps": {
"type": { "name": "object" },
"deprecated": true,
"deprecationInfo": "Use slotProps.backdrop instead."
},
"classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } },
"closeAfterTransition": { "type": { "name": "bool" }, "default": "false" },
"component": { "type": { "name": "elementType" } },
"components": {
"type": { "name": "shape", "description": "{ Backdrop?: elementType, Root?: elementType }" },
"default": "{}",
"deprecated": true,
"deprecationInfo": "Use the slots prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details."
},
"componentsProps": {
"type": {
"name": "shape",
"description": "{ backdrop?: func
| object, root?: func
| object }"
},
"default": "{}",
"deprecated": true,
"deprecationInfo": "Use the slotProps prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details."
},
"container": { "type": { "name": "union", "description": "HTML element
| func" } },
"disableAutoFocus": { "type": { "name": "bool" }, "default": "false" },
"disableEnforceFocus": { "type": { "name": "bool" }, "default": "false" },
"disableEscapeKeyDown": { "type": { "name": "bool" }, "default": "false" },
"disablePortal": { "type": { "name": "bool" }, "default": "false" },
"disableRestoreFocus": { "type": { "name": "bool" }, "default": "false" },
"disableScrollLock": { "type": { "name": "bool" }, "default": "false" },
"hideBackdrop": { "type": { "name": "bool" }, "default": "false" },
"keepMounted": { "type": { "name": "bool" }, "default": "false" },
"onClose": {
"type": { "name": "func" },
"signature": {
"type": "function(event: object, reason: string) => void",
"describedArgs": ["event", "reason"]
}
},
"onTransitionEnter": { "type": { "name": "func" } },
"onTransitionExited": { "type": { "name": "func" } },
"slotProps": {
"type": {
"name": "shape",
"description": "{ backdrop?: func
| object, root?: func
| object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ backdrop?: elementType, root?: elementType }" },
"default": "{}"
},
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
}
},
"name": "Modal",
"imports": ["import Modal from '@mui/material/Modal';", "import { Modal } from '@mui/material';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiModal-root"
},
{
"name": "backdrop",
"description": "The component that renders the backdrop.",
"class": "MuiModal-backdrop"
}
],
"classes": [
{
"key": "hidden",
"className": "MuiModal-hidden",
"description": "Class name applied to the root element if the `Modal` has exited.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": false,
"muiName": "MuiModal",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-material/src/Modal/Modal.js",
"inheritance": null,
"demos": "