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

Mention Material UI v5 update #1911

Merged
merged 3 commits into from
Apr 6, 2022
Merged
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
33 changes: 19 additions & 14 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@

## Migrating to JSON Forms 3.0 for React users

### Removal of React Material extended renderer set

Previously we maintained a separate 'extended' renderer set to not force all consumers of JSON Forms to consume the Material UI lab dependency.
With the update to Material UI v5 the lab dependency became more important as it also contains all date and time pickers.
Therefore we now require the lab dependency and removed the no longer needed extended renderer set.

If you consumed the extended renderer set then just revert to the normal renderer set.
There should not be any behavior changes.

### Removal of Class Components in React Material

With Version 3.0 of JSON Forms we removed all React Material class components.
Please check whether you extended any of our base renderers in your adaptation.

### Removal of JSON Schema $Ref Parser

With version 3.0 of JSON Forms, we removed the `json-schema-ref-parser` dependency within the core package.
Expand Down Expand Up @@ -79,6 +65,25 @@ function App() {

For more information have a look at our [ref-resolving](https://jsonforms.io/docs/ref-resolving) docs page.

### Update to Material UI v5 in React Material

Material UI was updated from version 4 to version 5 which introduced a lot of breaking changes.
To update your application see the official Material UI [migration guide](https://mui.com/guides/migration-v4/).

### Removal of React Material extended renderer set

Previously we maintained a separate 'extended' renderer set to not force all consumers of JSON Forms to consume the Material UI lab dependency.
With the update to Material UI v5 the lab dependency became more important as it also contains all date and time pickers.
Therefore we now require the lab dependency and removed the no longer needed extended renderer set.

If you consumed the extended renderer set then just revert to the normal renderer set.
There should not be any behavior changes.

### Removal of Class Components in React Material

All React Material class components were refactored to functional components.
Please check whether you extended any of our base renderers in your adaptation.

## Migrating to JSON Forms 2.5 for Angular users

The JsonFormsAngularService is not provided in the root anymore.
Expand Down