{
"props": {
"children": { "type": { "name": "custom", "description": "element" }, "required": true },
"open": { "type": { "name": "bool" }, "required": true },
"component": { "type": { "name": "elementType" } },
"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"]
}
},
"slotProps": {
"type": {
"name": "shape",
"description": "{ backdrop?: func
| object, root?: func
| object }"
},
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ backdrop?: elementType, root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
}
},
"name": "Modal",
"imports": ["import Modal from '@mui/joy/Modal';", "import { Modal } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiModal-root"
},
{
"name": "backdrop",
"description": "The component that renders the backdrop.",
"default": "'div'",
"class": "MuiModal-backdrop"
}
],
"classes": [
{
"key": "hidden",
"className": "MuiModal-hidden",
"description": "Class name applied to the root element when open is false.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": false,
"muiName": "JoyModal",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/Modal/Modal.tsx",
"inheritance": null,
"demos": "