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 migration to DataGrid v6 page #6235

Merged
merged 9 commits into from
Oct 10, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/data/data-grid/getting-started/migration-v5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Migration from v5 to v6

<p class="description">This guide describes the changes needed to migrate from v5 to v6.</p>

## Start using the alpha release

In `package.json`, change the version of the data grid package to `next`.

```diff
-"@mui/x-data-grid": "latest",
+"@mui/x-data-grid": "next",
```

Using `next` ensures that it will always use the latest v6 alpha release, but you can also use a fixed version, like `6.0.0-alpha.0`.

## Breaking changes

Since v6 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 v5 to v6.

m4theushw marked this conversation as resolved.
Show resolved Hide resolved
:::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.
:::

<!--
### CSS classes

TBD

### Virtualization

TBD

### Removed props

TBD

### State access

TBD

### `apiRef` methods

TBD

### Columns

TBD

### Other exports

TBD

### Removals from the public API

TBD
-->
1 change: 1 addition & 0 deletions docs/data/pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ const pages: MuiPage[] = [
{ pathname: '/x/react-data-grid/demo' },
{ pathname: '/x/react-data-grid/getting-started' },
{ pathname: '/x/react-data-grid/migration-v4', title: 'Migration from v4' },
{ pathname: '/x/react-data-grid/migration-v5', title: 'Migration from v5' },
m4theushw marked this conversation as resolved.
Show resolved Hide resolved
{ pathname: '/x/react-data-grid/layout' },
{
pathname: '/x/react-data-grid/columns',
Expand Down
11 changes: 11 additions & 0 deletions docs/pages/x/react-data-grid/migration-v5.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import {
demos,
docs,
demoComponents,
} from 'docsx/data/data-grid/getting-started/migration-v5.md?@mui/markdown';
cherniavskii marked this conversation as resolved.
Show resolved Hide resolved

export default function Page() {
return <MarkdownDocs demos={demos} docs={docs} demoComponents={demoComponents} />;
}