-
-
Notifications
You must be signed in to change notification settings - Fork 32.8k
[material-ui][docs] Add deprecations migration guide #40767
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
DiegoAndai
merged 9 commits into
mui:master
from
DiegoAndai:deprecations-migration-guide
Feb 6, 2024
Merged
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2e776b7
Add deprecations migration guide
DiegoAndai cf4d74b
Address reviewdog review
DiegoAndai c736429
Improve copy and add placeholder links
DiegoAndai d1cce84
Add links and reduce duplication
DiegoAndai 43fb3c6
Add link in deprecated Accordion props to guide
DiegoAndai 4cc8786
Apply suggestions from code review
DiegoAndai a652ff4
Update file names and copy
DiegoAndai f8af7de
Replace regular space with non-breaking space
DiegoAndai 46623cb
trigger ci
DiegoAndai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
51 changes: 51 additions & 0 deletions
51
docs/data/material/migration/migrating-deprecations/migrating-deprecations.md
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Migrating deprecations | ||
|
|
||
| <p class="description">This guide explains how to migrate current deprecated APIs.</p> | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Why you should migrate | ||
|
|
||
| Deprecations are added as APIs are improved. | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Migrating to these improved APIs results in a better developer experience. | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| The sooner you migrate, the smoother future major updates become. | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Migrating | ||
|
|
||
| The easiest way to migrate is running the `deprecations/all` codemod: | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```bash | ||
| npx @mui/codemod@latest deprecations/all <path> | ||
| ``` | ||
|
|
||
| This command runs all the current [deprecations codemods](https://github.com/mui/material-ui/tree/master/packages/mui-codemod#deprecations), automatically migrating to the updated API. | ||
| This codemod can be run multiple times to keep up with new deprecations. | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| :::info | ||
|
|
||
| If you need to migrate a deprecation manually, examples on how to do so are listed below for each current deprecation. | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| If you need to run a specific codemod, those are also linked below. | ||
|
|
||
| ::: | ||
|
|
||
| ## Accordion | ||
|
|
||
| ### TransitionComponent | ||
|
|
||
| Deprecated in favor of `slots.transition` ([Codemod](https://github.com/mui/material-ui/tree/master/packages/mui-codemod#accordion-props)). | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```diff | ||
| <Accordion | ||
| - TransitionComponent={CustomTransition} | ||
| + slots={{ transition: CustomTransition }} | ||
| /> | ||
| ``` | ||
|
|
||
| ### TransitionProps | ||
|
|
||
| Deprecated in favor of `slotProps.transition` ([Codemod](https://github.com/mui/material-ui/tree/master/packages/mui-codemod#accordion-props)). | ||
DiegoAndai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```diff | ||
| <Accordion | ||
| - TransitionProps={{ unmountOnExit: true }} | ||
| + slotProps={{ transition: { unmountOnExit: true } }} | ||
| /> | ||
| ``` | ||
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import * as React from 'react'; | ||
| import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; | ||
| import * as pageProps from 'docs/data/material/migration/migrating-deprecations/migrating-deprecations.md?@mui/markdown'; | ||
|
|
||
| export default function Page() { | ||
| return <MarkdownDocs {...pageProps} />; | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.