-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Add v6 to v7 migration guide (#45143)
- Loading branch information
1 parent
247c597
commit 46b085f
Showing
7 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
docs/data/material/migration/upgrade-to-v7/upgrade-to-v7.md
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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Upgrade to v7 | ||
|
||
<p class="description">This guide explains how to upgrade from Material UI v6 to v7.</p> | ||
|
||
## Start using the alpha release | ||
|
||
In the `package.json` file, change the package version from `latest` to `next`. | ||
|
||
```diff title="package.json" | ||
-"@mui/material": "latest", | ||
+"@mui/material": "next", | ||
``` | ||
|
||
Using `next` ensures your project always uses the latest v7 pre-releases. | ||
Alternatively, you can also target and fix it to a specific version, for example, `7.0.0-alpha.0`. | ||
|
||
## Breaking changes | ||
|
||
Since v7 is a new major release, it contains some changes that affect the public API. | ||
The steps you need to take to migrate from Material UI v6 to v7 are described below. | ||
|
||
:::info | ||
This list is a work in progress. | ||
Expect updates as new breaking changes are introduced. | ||
::: |
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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Upgrade to v7 | ||
|
||
<p class="description">This guide explains how to upgrade from MUI System v6 to v7.</p> | ||
|
||
## Start using the alpha release | ||
|
||
In the `package.json` file, change the package version from `latest` to `next`. | ||
|
||
```diff title="package.json" | ||
-"@mui/system": "latest", | ||
+"@mui/system": "next", | ||
``` | ||
|
||
Using `next` ensures your project always uses the latest v7 pre-releases. | ||
Alternatively, you can also target and fix it to a specific version, for example, `7.0.0-alpha.0`. | ||
|
||
## Breaking changes | ||
|
||
Since v7 is a new major release, it contains some changes that affect the public API. | ||
The steps you need to take to migrate from MUI System v6 to v7 are described below. | ||
|
||
:::info | ||
This list is a work in progress. | ||
Expect updates as new breaking changes are introduced. | ||
::: |
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 |
---|---|---|
@@ -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/upgrade-to-v7/upgrade-to-v7.md?muiMarkdown'; | ||
|
||
export default function Page() { | ||
return <MarkdownDocs {...pageProps} />; | ||
} |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import * as React from 'react'; | ||
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; | ||
import * as pageProps from 'docs/data/system/migration/upgrade-to-v7/upgrade-to-v7.md?muiMarkdown'; | ||
|
||
export default function Page() { | ||
return <MarkdownDocs {...pageProps} />; | ||
} |
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