Skip to content

Commit 79288d2

Browse files
authored
Add Material UI v5 to migration guide
Adds information to the migration guide regarding the Material UI v5 update. Also slightly restructures the migration guide entries to order them according to importance. closes #1850 Signed-off-by: Lukas Boll lukas-bool@web.de
1 parent 67b036e commit 79288d2

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

MIGRATION.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,6 @@
22

33
## Migrating to JSON Forms 3.0 for React users
44

5-
### Removal of React Material extended renderer set
6-
7-
Previously we maintained a separate 'extended' renderer set to not force all consumers of JSON Forms to consume the Material UI lab dependency.
8-
With the update to Material UI v5 the lab dependency became more important as it also contains all date and time pickers.
9-
Therefore we now require the lab dependency and removed the no longer needed extended renderer set.
10-
11-
If you consumed the extended renderer set then just revert to the normal renderer set.
12-
There should not be any behavior changes.
13-
14-
### Removal of Class Components in React Material
15-
16-
With Version 3.0 of JSON Forms we removed all React Material class components.
17-
Please check whether you extended any of our base renderers in your adaptation.
18-
195
### Removal of JSON Schema $Ref Parser
206

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

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

68+
### Update to Material UI v5 in React Material
69+
70+
Material UI was updated from version 4 to version 5 which introduced a lot of breaking changes.
71+
To update your application see the official Material UI [migration guide](https://mui.com/guides/migration-v4/).
72+
73+
### Removal of React Material extended renderer set
74+
75+
Previously we maintained a separate 'extended' renderer set to not force all consumers of JSON Forms to consume the Material UI lab dependency.
76+
With the update to Material UI v5 the lab dependency became more important as it also contains all date and time pickers.
77+
Therefore we now require the lab dependency and removed the no longer needed extended renderer set.
78+
79+
If you consumed the extended renderer set then just revert to the normal renderer set.
80+
There should not be any behavior changes.
81+
82+
### Removal of Class Components in React Material
83+
84+
All React Material class components were refactored to functional components.
85+
Please check whether you extended any of our base renderers in your adaptation.
86+
8287
## Migrating to JSON Forms 2.5 for Angular users
8388

8489
The JsonFormsAngularService is not provided in the root anymore.

0 commit comments

Comments
 (0)