121 lines
8.3 KiB
JSON
121 lines
8.3 KiB
JSON
|
{
|
||
|
|
"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 <code>true</code>, the backdrop is not rendered." },
|
||
|
|
"ModalProps": {
|
||
|
|
"description": "Props applied to the <a href=\"https://mui.com/material-ui/api/modal/\"><code>Modal</code></a> element."
|
||
|
|
},
|
||
|
|
"onClose": {
|
||
|
|
"description": "Callback fired when the component requests to be closed. The <code>reason</code> parameter can optionally be used to control the response to <code>onClose</code>.",
|
||
|
|
"typeDescriptions": {
|
||
|
|
"event": { "name": "event", "description": "The event source of the callback." },
|
||
|
|
"reason": {
|
||
|
|
"name": "reason",
|
||
|
|
"description": "Can be: <code>"escapeKeyDown"</code>, <code>"backdropClick"</code>."
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"open": { "description": "If <code>true</code>, the component is shown." },
|
||
|
|
"PaperProps": {
|
||
|
|
"description": "Props applied to the <a href=\"https://mui.com/material-ui/api/paper/\"><code>Paper</code></a> element."
|
||
|
|
},
|
||
|
|
"SlideProps": {
|
||
|
|
"description": "Props applied to the <a href=\"https://mui.com/material-ui/api/slide/\"><code>Slide</code></a> 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": "<code>anchor=\"bottom\"</code>"
|
||
|
|
},
|
||
|
|
"anchorLeft": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>anchor=\"left\"</code>"
|
||
|
|
},
|
||
|
|
"anchorRight": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>anchor=\"right\"</code>"
|
||
|
|
},
|
||
|
|
"anchorTop": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the root element",
|
||
|
|
"conditions": "<code>anchor=\"top\"</code>"
|
||
|
|
},
|
||
|
|
"modal": {
|
||
|
|
"description": "Styles applied to {{nodeName}}.",
|
||
|
|
"nodeName": "the Modal component"
|
||
|
|
},
|
||
|
|
"paperAnchorBottom": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"bottom\"</code>",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorBottom\">.MuiDrawer-anchorBottom</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
},
|
||
|
|
"paperAnchorDockedBottom": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"bottom\"</code> and <code>variant</code> is not "temporary"",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorBottom\">.MuiDrawer-anchorBottom</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
},
|
||
|
|
"paperAnchorDockedLeft": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"left\"</code> and <code>variant</code> is not "temporary"",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorLeft\">.MuiDrawer-anchorLeft</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
},
|
||
|
|
"paperAnchorDockedRight": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"right\"</code> and <code>variant</code> is not "temporary"",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorRight\">.MuiDrawer-anchorRight</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
},
|
||
|
|
"paperAnchorDockedTop": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"top\"</code> and <code>variant</code> is not "temporary"",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorTop\">.MuiDrawer-anchorTop</a>, <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-docked\">.MuiDrawer-docked</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
},
|
||
|
|
"paperAnchorLeft": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"left\"</code>",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorLeft\">.MuiDrawer-anchorLeft</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
},
|
||
|
|
"paperAnchorRight": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"right\"</code>",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorRight\">.MuiDrawer-anchorRight</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
},
|
||
|
|
"paperAnchorTop": {
|
||
|
|
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
|
||
|
|
"nodeName": "the Paper component",
|
||
|
|
"conditions": "<code>anchor=\"top\"</code>",
|
||
|
|
"deprecationInfo": "Combine the <a href=\"/material-ui/api/drawer/#drawer-classes-MuiDrawer-anchorTop\">.MuiDrawer-anchorTop</a> and <a href=\"/material-ui/api/drawer/#Drawer-css-MuiDrawer-paper\">.MuiDrawer-paper</a> classes instead. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"slotDescriptions": {
|
||
|
|
"backdrop": "The component used for the Modal backdrop.",
|
||
|
|
"docked": "The component used for the root element when the variant is <code>permanent</code> or <code>persistent</code>.",
|
||
|
|
"paper": "The component used for the paper.",
|
||
|
|
"root": "The component used for the root when the variant is <code>temporary</code>.",
|
||
|
|
"transition": "The component used for the transition. <a href=\"https://mui.com/material-ui/transitions/#transitioncomponent-prop\">Follow this guide</a> to learn more about the requirements for this component."
|
||
|
|
}
|
||
|
|
}
|