From 8470f056aa8fd43113423ddb38891fa3d3c88244 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Tue, 23 Jan 2024 13:55:42 +0100 Subject: [PATCH] docs update --- docs/pages/material-ui/api/backdrop.json | 26 ++++++++++++------- .../api-docs/backdrop/backdrop.json | 4 +-- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/docs/pages/material-ui/api/backdrop.json b/docs/pages/material-ui/api/backdrop.json index 1625d1e4188f79..07b611ac801b51 100644 --- a/docs/pages/material-ui/api/backdrop.json +++ b/docs/pages/material-ui/api/backdrop.json @@ -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
| object }" + }, "default": "{}" }, "slots": { @@ -31,7 +34,12 @@ }, "additionalInfo": { "sx": true } }, - "TransitionComponent": { "type": { "name": "elementType" }, "default": "Fade" }, + "TransitionComponent": { + "type": { "name": "elementType" }, + "default": "Fade", + "deprecated": true, + "deprecationInfo": "Use slots.transition instead. This prop will be removed in v7." + }, "transitionDuration": { "type": { "name": "union", @@ -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 } ], @@ -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, diff --git a/docs/translations/api-docs/backdrop/backdrop.json b/docs/translations/api-docs/backdrop/backdrop.json index c0723c93165f15..ea6c76a559ffc1 100644 --- a/docs/translations/api-docs/backdrop/backdrop.json +++ b/docs/translations/api-docs/backdrop/backdrop.json @@ -37,10 +37,10 @@ "description": "Styles applied to {{nodeName}} if {{conditions}}.", "nodeName": "the root element", "conditions": "invisible={true}" - }, - "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." } }