[docs] Bring back *Component and *Props codemods and deprecation messages
#44383
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,8 +35,16 @@ | |
| }, | ||
| "additionalInfo": { "sx": true } | ||
| }, | ||
| "TransitionComponent": { | ||
| "type": { "name": "elementType" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slots.transition</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "TransitionProps": { | ||
| "type": { "name": "object" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slotProps.transition</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| } | ||
| }, | ||
| "name": "Accordion", | ||
| "imports": [ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,11 @@ | |
| }, | ||
| "default": "false" | ||
| }, | ||
| "ChipProps": { | ||
| "type": { "name": "object" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slotProps.chip</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } }, | ||
| "clearIcon": { "type": { "name": "node" }, "default": "<ClearIcon fontSize=\"small\" />" }, | ||
| "clearOnBlur": { "type": { "name": "bool" }, "default": "!props.freeSolo" }, | ||
|
|
@@ -93,8 +97,17 @@ | |
| } | ||
| }, | ||
| "limitTags": { "type": { "name": "custom", "description": "integer" }, "default": "-1" }, | ||
| "ListboxComponent": { | ||
| "type": { "name": "elementType" }, | ||
| "default": "'ul'", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slotProps.listbox.component</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "ListboxProps": { | ||
| "type": { "name": "object" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slotProps.listbox</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "loading": { "type": { "name": "bool" }, "default": "false" }, | ||
| "loadingText": { "type": { "name": "node" }, "default": "'Loading…'" }, | ||
| "multiple": { "type": { "name": "bool" }, "default": "false" }, | ||
|
|
@@ -137,8 +150,18 @@ | |
| "open": { "type": { "name": "bool" } }, | ||
| "openOnFocus": { "type": { "name": "bool" }, "default": "false" }, | ||
| "openText": { "type": { "name": "string" }, "default": "'Open'" }, | ||
| "PaperComponent": { | ||
| "type": { "name": "elementType" }, | ||
| "default": "Paper", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slots.paper</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "PopperComponent": { | ||
| "type": { "name": "elementType" }, | ||
| "default": "Popper", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slots.popper</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "popupIcon": { "type": { "name": "node" }, "default": "<ArrowDropDownIcon />" }, | ||
| "readOnly": { "type": { "name": "bool" }, "default": "false" }, | ||
| "renderGroup": { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,11 @@ | |
| "children": { "type": { "name": "node" } }, | ||
| "classes": { "type": { "name": "object" }, "additionalInfo": { "cssApi": true } }, | ||
| "component": { "type": { "name": "elementType" } }, | ||
| "imgProps": { | ||
| "type": { "name": "object" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slotProps.img</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "sizes": { "type": { "name": "string" } }, | ||
| "slotProps": { | ||
| "type": { "name": "shape", "description": "{ img?: func<br>| object }" }, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,7 +38,12 @@ | |
| }, | ||
| "additionalInfo": { "sx": true } | ||
| }, | ||
| "TransitionComponent": { | ||
| "type": { "name": "elementType" }, | ||
| "default": "Fade", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slots.transition</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "transitionDuration": { | ||
| "type": { | ||
| "name": "union", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,15 +44,24 @@ | |
| }, | ||
| "additionalInfo": { "sx": true } | ||
| }, | ||
| "TransitionComponent": { | ||
| "type": { "name": "elementType" }, | ||
| "default": "Zoom\n* @deprecated Use `slots.transition` instead. This prop will be removed in v7. [How to migrate](/material-ui/migration/migrating-from-deprecated-apis/)", | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slots.transition</code> instead. This prop will be removed in v7. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>" | ||
| }, | ||
| "transitionDuration": { | ||
| "type": { | ||
| "name": "union", | ||
| "description": "number<br>| { appear?: number, enter?: number, exit?: number }" | ||
| }, | ||
| "default": "{\n enter: theme.transitions.duration.enteringScreen,\n exit: theme.transitions.duration.leavingScreen,\n}" | ||
| }, | ||
| "TransitionProps": { | ||
| "type": { "name": "object" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slotProps.transition</code> instead. This prop will be removed in v7. <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">How to migrate</a>" | ||
| } | ||
| }, | ||
| "name": "SpeedDial", | ||
| "imports": [ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,8 +22,16 @@ | |
| "type": { "name": "shape", "description": "{ label?: elementType, stepIcon?: elementType }" }, | ||
| "default": "{}" | ||
| }, | ||
| "StepIconComponent": { | ||
| "type": { "name": "elementType" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slots.stepIcon</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "StepIconProps": { | ||
| "type": { "name": "object" }, | ||
| "deprecated": true, | ||
| "deprecationInfo": "Use <code>slotProps.stepIcon</code> instead. This prop will be removed in v7. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details." | ||
| }, | ||
| "sx": { | ||
| "type": { | ||
| "name": "union", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -275,12 +275,14 @@ npx @mui/codemod@latest deprecations/alert-props <path> | |
| - }} | ||
| + slots={{ | ||
| + paper: CustomPaper, | ||
| + popper: CustomPopper | ||
| + }} | ||
| + slotProps={{ | ||
| + chip: { height: 10 }, | ||
| + listbox: { | ||
| + component: CustomListbox, | ||
| + ...{ height: 12 }, | ||
| + }, | ||
| + clearIndicator: { width: 10 }, | ||
| + paper: { width: 12 }, | ||
| + popper: { width: 14 }, | ||
|
|
@@ -306,11 +308,13 @@ npx @mui/codemod@latest deprecations/alert-props <path> | |
| + slots: { | ||
| + paper: CustomPaper, | ||
| + popper: CustomPopper, | ||
| + }, | ||
| + slotProps: { | ||
| + chip: { height: 10 }, | ||
| + listbox: { | ||
| + component: CustomListbox, | ||
| + ...{ height: 12 }, | ||
| + }, | ||
| + clearIndicator: { width: 10 }, | ||
| + paper: { width: 12 }, | ||
| + popper: { width: 14 }, | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page could become confusing. If we plan to continue to add these sections here, we should include the version in which the new API was introduced. Otherwise people may run the codemod while installing an older version (e.g. 6.0.0).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll look into how to do this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mnajdova what do you think about this approach:
If you agree, this PR doesn't need any change, as these APIs were introduced in 6.0.0. The deprecation messages were omitted while we discussed the direction of the slot pattern, which is why we are bringing them back now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree, ok I see, I thought the APIs were introduced later.