{
"componentDescription": "The props of the [Modal](/material-ui/api/modal/) component are available\nwhen `variant=\"temporary\"` is set.",
"propDescriptions": {
"anchor": { "description": "Side from which the drawer will appear." },
"children": { "description": "The content of the component." },
"classes": { "description": "Override or extend the styles applied to the component." },
"elevation": { "description": "The elevation of the drawer." },
"hideBackdrop": { "description": "If true, the backdrop is not rendered." },
"ModalProps": {
"description": "Props applied to the Modal element."
},
"onClose": {
"description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.",
"typeDescriptions": {
"event": { "name": "event", "description": "The event source of the callback." },
"reason": {
"name": "reason",
"description": "Can be: "escapeKeyDown", "backdropClick"."
}
}
},
"open": { "description": "If true, the component is shown." },
"PaperProps": {
"description": "Props applied to the Paper element."
},
"SlideProps": {
"description": "Props applied to the Slide element."
},
"slotProps": { "description": "The props used for each slot inside." },
"slots": { "description": "The components used for each slot inside." },
"sx": {
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
},
"transitionDuration": {
"description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object."
},
"variant": { "description": "The variant to use." }
},
"classDescriptions": {
"anchorBottom": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "anchor=\"bottom\""
},
"anchorLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "anchor=\"left\""
},
"anchorRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "anchor=\"right\""
},
"anchorTop": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "anchor=\"top\""
},
"modal": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the Modal component"
},
"paperAnchorBottom": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"bottom\"",
"deprecationInfo": "Combine the .MuiDrawer-anchorBottom and .MuiDrawer-paper classes instead. How to migrate"
},
"paperAnchorDockedBottom": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"bottom\" and variant is not "temporary"",
"deprecationInfo": "Combine the .MuiDrawer-anchorBottom, .MuiDrawer-docked and .MuiDrawer-paper classes instead. How to migrate"
},
"paperAnchorDockedLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"left\" and variant is not "temporary"",
"deprecationInfo": "Combine the .MuiDrawer-anchorLeft, .MuiDrawer-docked and .MuiDrawer-paper classes instead. How to migrate"
},
"paperAnchorDockedRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"right\" and variant is not "temporary"",
"deprecationInfo": "Combine the .MuiDrawer-anchorRight, .MuiDrawer-docked and .MuiDrawer-paper classes instead. How to migrate"
},
"paperAnchorDockedTop": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"top\" and variant is not "temporary"",
"deprecationInfo": "Combine the .MuiDrawer-anchorTop, .MuiDrawer-docked and .MuiDrawer-paper classes instead. How to migrate"
},
"paperAnchorLeft": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"left\"",
"deprecationInfo": "Combine the .MuiDrawer-anchorLeft and .MuiDrawer-paper classes instead. How to migrate"
},
"paperAnchorRight": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"right\"",
"deprecationInfo": "Combine the .MuiDrawer-anchorRight and .MuiDrawer-paper classes instead. How to migrate"
},
"paperAnchorTop": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the Paper component",
"conditions": "anchor=\"top\"",
"deprecationInfo": "Combine the .MuiDrawer-anchorTop and .MuiDrawer-paper classes instead. How to migrate"
}
},
"slotDescriptions": {
"backdrop": "The component used for the Modal backdrop.",
"docked": "The component used for the root element when the variant is permanent or persistent.",
"paper": "The component used for the paper.",
"root": "The component used for the root when the variant is temporary.",
"transition": "The component used for the transition. Follow this guide to learn more about the requirements for this component."
}
}