Add deprecation warning to components and componentProps

mui · Apr 25, 2024 · 6d0b35b · 6d0b35b
1 parent c9bef2c
commit 6d0b35b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 16 deletions.
diff --git a/docs/pages/material-ui/api/backdrop.json b/docs/pages/material-ui/api/backdrop.json
@@ -6,7 +6,9 @@
     "component": { "type": { "name": "elementType" } },
     "components": {
       "type": { "name": "shape", "description": "{ Root?: elementType }" },
-      "default": "{}"
+      "default": "{}",
+      "deprecated": true,
+      "deprecationInfo": "use the <code>slots</code> prop instead. This prop will be removed in v7. <a href=\"material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>"
     },
     "componentsProps": {
       "type": { "name": "shape", "description": "{ root?: object }" },

diff --git a/packages/mui-codemod/src/deprecations/backdrop-props/test-cases/actual.js b/packages/mui-codemod/src/deprecations/backdrop-props/test-cases/actual.js
@@ -1,26 +1,26 @@
 import Backdrop from '@mui/material/Backdrop';
 import { Backdrop as MyBackdrop } from '@mui/material';
 
-<Backdrop TransitionComponent={CustomTransition} />;
-<MyBackdrop TransitionComponent={CustomTransition} />;
+<Backdrop slots={{
+  transition: CustomTransition
+}} />;
+<MyBackdrop slots={{
+  transition: CustomTransition
+}} />;
 <Backdrop
-  TransitionComponent={CustomTransition}
   slots={{
     root: 'div',
-  }}
-/>;
+    transition: CustomTransition
+  }} />;
 <MyBackdrop
-  TransitionComponent={CustomTransition}
   slots={{
     ...outerSlots,
-  }}
-/>;
+    transition: CustomTransition
+  }} />;
 <Backdrop
-  TransitionComponent={ComponentTransition}
   slots={{
     root: 'div',
     transition: SlotTransition
-  }}
-/>;
+  }} />;
 // should skip non MUI components
 <NonMuiBackdrop TransitionComponent={CustomTransition} />;
diff --git a/packages/mui-material/src/Backdrop/Backdrop.d.ts b/packages/mui-material/src/Backdrop/Backdrop.d.ts
@@ -52,8 +52,7 @@ export interface BackdropOwnProps
   /**
    * The components used for each slot inside.
    *
-   * This prop is an alias for the `slots` prop.
-   * It's recommended to use the `slots` prop instead.
+   * @deprecated use the `slots` prop instead. This prop will be removed in v7. [How to migrate](/material-ui/migration/migrating-from-deprecated-apis/).
    *
    * @default {}
    */
@@ -64,8 +63,7 @@ export interface BackdropOwnProps
    * The extra props for the slot components.
    * You can override the existing props or add new ones.
    *
-   * This prop is an alias for the `slotProps` prop.
-   * It's recommended to use the `slotProps` prop instead, as `componentsProps` will be deprecated in the future.
+   * @deprecated use the `slots` prop instead. This prop will be removed in v7. [How to migrate](/material-ui/migration/migrating-from-deprecated-apis/).
    *
    * @default {}
    */