You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/react-renderer-demo/src/pages/provided-mappers/mui-component-mapper.md
+43Lines changed: 43 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -36,4 +36,47 @@ MUI mapper provides an option to validate a field when the component is mounted.
36
36
37
37
This field will show the error immediately.
38
38
39
+
## Migration to version 5
40
+
41
+
MaterialUI (now known just as MUI) recently released a version 5 that introduces a lot of new features and some breaking changes. Data Driven Forms follows this release with our integration in `mui-component-mapper`. Due to inability to release new version of packages independently, we are going to introduce new changes as a feature release to not disrupt any other mappers. We deeply apologise for any issues it can introduce, but we agreed that this is the best way that won't break any of our current workflows.
42
+
43
+
### Migration
44
+
45
+
#### Convert your app to use MUI 5
46
+
47
+
Please follow [official migration guide](https://mui.com/guides/migration-v4/). *Note: emotion packages are being installed by the mapper itself.*
48
+
49
+
#### Use beta version of the mapper
50
+
51
+
Use `3.16.0-v5-beta` version (or check if there is any newer version of v5 version [here](https://www.npmjs.com/package/@data-driven-forms/mui-component-mapper).)
52
+
53
+
<br />
54
+
55
+
**And that's it!**
56
+
57
+
<br />
58
+
59
+
`mui-component-mapper` itself does not require any additional migration steps!
60
+
61
+
Only if you are using `date-picker` or `time-picker`, you have to provide `LocalizationProvider` ([read more](https://mui.com/components/time-picker/#localization)), the components themselves do not longer contain it.
62
+
63
+
### Feedback
64
+
65
+
If you encounter any issues, please let us know in [our Issues section](https://github.com/data-driven-forms/react-forms/issues).
66
+
67
+
### What if I do not want to migrate
68
+
69
+
Please lock your `mui-component-mapper` version in `package.json`:
For any future bug fixes, we will use `3.15` as a base version. (example: next bugfix would be `3.15.6` and these versions will be tagged as `deprecated`.)
79
+
80
+
In the near future, we will support bugfixes for Material-UI v4 mapper version, but no new features will be implemented. We are open to accept PRs by community. Also, this older version should work with the latest `react-form-renderer` at least until Data Driven Forms version 4 is released.
0 commit comments