Skip to content
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

[docs] Add v6 to v7 migration guide #45143

Merged
merged 3 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/data/material/migration/upgrade-to-v7/upgrade-to-v7.md
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.
:::
10 changes: 10 additions & 0 deletions docs/data/material/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,16 @@ const pages: MuiPage[] = [
pathname: '/material-ui/migration/pickers-migration',
title: 'Migration from @material-ui/pickers',
},
{
pathname: '/material-ui/migration/v7',
subheader: 'Upgrade to v7',
children: [
{
pathname: '/material-ui/migration/upgrade-to-v7',
title: 'Upgrade to v7: getting started',
},
],
},
{
pathname: '/material-ui/migration/v6',
subheader: 'Upgrade to v6',
Expand Down
25 changes: 25 additions & 0 deletions docs/data/system/migration/upgrade-to-v7/upgrade-to-v7.md
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.
:::
4 changes: 4 additions & 0 deletions docs/data/system/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ const pages: readonly MuiPage[] = [
pathname: '/system/migration',
title: 'Migration',
children: [
{
pathname: '/system/migration/upgrade-to-v7',
title: 'Upgrade to v7',
},
{
pathname: '/system/migration/migrating-to-v6',
title: 'Migrating to v6',
Expand Down
7 changes: 7 additions & 0 deletions docs/pages/material-ui/migration/upgrade-to-v7.js
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} />;
}
7 changes: 7 additions & 0 deletions docs/pages/system/migration/upgrade-to-v7.js
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} />;
}
3 changes: 3 additions & 0 deletions docs/translations/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"/system/react-grid": "Grid",
"/system/react-stack": "Stack",
"/system/migration": "Migration",
"/system/migration/upgrade-to-v7": "Upgrade to v7",
"/system/migration/migrating-to-v6": "Migrating to v6",
"/system/experimental-api": "Experimental APIs",
"/system/experimental-api/configure-the-sx-prop": "Configure the sx prop",
Expand Down Expand Up @@ -262,6 +263,8 @@
"/material-ui/migration": "Migration",
"/material-ui/migration/migration-grid-v2": "Migrating to Grid v2",
"/material-ui/migration/pickers-migration": "Migration from @material-ui/pickers",
"Upgrade to v7": "Upgrade to v7",
"/material-ui/migration/upgrade-to-v7": "Upgrade to v7: getting started",
"Upgrade to v6": "Upgrade to v6",
"/material-ui/migration/upgrade-to-v6": "Upgrade to v6: getting started",
"/material-ui/migration/migrating-from-deprecated-apis": "Migrating from deprecated APIs",
Expand Down