-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Start v8 migration guides (#15096)
- Loading branch information
1 parent
0f3eb1e
commit d0f535d
Showing
7 changed files
with
135 additions
and
0 deletions.
There are no files selected for viewing
34 changes: 34 additions & 0 deletions
34
docs/data/migration/migration-charts-v7/migration-charts-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,34 @@ | ||
--- | ||
productId: x-charts | ||
--- | ||
|
||
# Migration from v7 to v8 | ||
|
||
<p class="description">This guide describes the changes needed to migrate Charts from v7 to v8.</p> | ||
|
||
## Introduction | ||
|
||
This is a reference guide for upgrading `@mui/x-charts` from v7 to v8. | ||
The change between v7 and v8 is mostly here to match the version with other MUI X packages. | ||
No big breaking changes are expected. | ||
|
||
## Start using the new release | ||
|
||
In `package.json`, change the version of the charts package to `next`. | ||
|
||
```diff | ||
-"@mui/x-charts": "^7.0.0", | ||
+"@mui/x-charts": "next", | ||
``` | ||
|
||
Using `next` ensures that it will always use the latest v8 pre-release version, but you can also use a fixed version, like `8.0.0-alpha.0`. | ||
|
||
## Breaking changes | ||
|
||
Since v8 is a major release, it contains some changes that affect the public API. | ||
These changes were done for consistency, improve stability and make room for new features. | ||
Below are described the steps you need to make to migrate from v7 to v8. | ||
|
||
:::info | ||
The list is currently empty, but as we move forward with development during the alpha and beta phases, we'll feed this page with all changes in the API. | ||
::: |
78 changes: 78 additions & 0 deletions
78
docs/data/migration/migration-data-grid-v7/migration-data-grid-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,78 @@ | ||
--- | ||
productId: x-data-grid | ||
--- | ||
|
||
# Migration from v7 to v8 | ||
|
||
<p class="description">This guide describes the changes needed to migrate the Data Grid from v7 to v8.</p> | ||
|
||
## Introduction | ||
|
||
This is a reference guide for upgrading `@mui/x-data-grid` from v7 to v8. | ||
|
||
## Start using the new release | ||
|
||
In `package.json`, change the version of the Data Grid package to `next`. | ||
|
||
```diff | ||
-"@mui/x-data-grid": "^7.0.0", | ||
+"@mui/x-data-grid": "next", | ||
|
||
-"@mui/x-data-grid-pro": "^7.0.0", | ||
+"@mui/x-data-grid-pro": "next", | ||
|
||
-"@mui/x-data-grid-premium": "^7.0.0", | ||
+"@mui/x-data-grid-premium": "next", | ||
``` | ||
|
||
Using `next` ensures that it will always use the latest v8 pre-release version, but you can also use a fixed version, like `8.0.0-alpha.0`. | ||
|
||
## Breaking changes | ||
|
||
Since v8 is a major release, it contains some changes that affect the public API. | ||
These changes were done for consistency, improve stability and make room for new features. | ||
Below are described the steps you need to make to migrate from v7 to v8. | ||
|
||
:::info | ||
The list is currently empty, but as we move forward with development during the alpha and beta phases, we'll feed this page with all changes in the API. | ||
::: | ||
|
||
<!-- ### Columns | ||
TBD | ||
### Rows | ||
TBD | ||
### `apiRef` methods | ||
TBD | ||
### Selection | ||
TBD | ||
### Accessibility | ||
TBD | ||
### Editing | ||
TBD | ||
### Other exports | ||
TBD | ||
### CSS classes and styling | ||
TBD | ||
### Changes to the public API | ||
TBD | ||
### Changes to slots | ||
TBD --> |
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
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 'docsx/data/migration/migration-charts-v7/migration-charts-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 'docsx/data/migration/migration-data-grid-v7/migration-data-grid-v7.md?muiMarkdown'; | ||
|
||
export default function Page() { | ||
return <MarkdownDocs {...pageProps} />; | ||
} |