Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Harry Whorlow committed Jan 23, 2024
1 parent e0a1290 commit 8470f05
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
26 changes: 17 additions & 9 deletions docs/pages/material-ui/api/backdrop.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@
},
"invisible": { "type": { "name": "bool" }, "default": "false" },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: object }" },
"type": {
"name": "shape",
"description": "{ root?: object, transition?: func<br>&#124;&nbsp;object }"
},
"default": "{}"
},
"slots": {
Expand All @@ -31,7 +34,12 @@
},
"additionalInfo": { "sx": true }
},
"TransitionComponent": { "type": { "name": "elementType" }, "default": "Fade" },
"TransitionComponent": {
"type": { "name": "elementType" },
"default": "Fade",
"deprecated": true,
"deprecationInfo": "Use <code>slots.transition</code> instead. This prop will be removed in v7."
},
"transitionDuration": {
"type": {
"name": "union",
Expand All @@ -45,10 +53,16 @@
"import { Backdrop } from '@mui/material';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiBackdrop-root"
},
{
"name": "transition",
"description": "The component that renders the transition.\n[Follow this guide](/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.",
"default": "Collapse",
"default": "Fade",
"class": null
}
],
Expand All @@ -58,12 +72,6 @@
"className": "MuiBackdrop-invisible",
"description": "Styles applied to the root element if `invisible={true}`.",
"isGlobal": false
},
{
"key": "root",
"className": "MuiBackdrop-root",
"description": "Styles applied to the root element.",
"isGlobal": false
}
],
"spread": true,
Expand Down
4 changes: 2 additions & 2 deletions docs/translations/api-docs/backdrop/backdrop.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "<code>invisible={true}</code>"
},
"root": { "description": "Styles applied to the root element." }
}
},
"slotDescriptions": {
"root": "The component that renders the root.",
"transition": "The component that renders the transition.\n[Follow this guide](/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component."
}
}

0 comments on commit 8470f05

Please sign in to comment.