Skip to content

Commit d762d53

Browse files
authored
Merge pull request #1176 from rvsia/updateDocMUI5
Update docs for MUI5 mapper
2 parents 5db5d43 + 6426859 commit d762d53

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

packages/react-renderer-demo/src/pages/provided-mappers/mui-component-mapper.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
import DocPage from '@docs/doc-page';
22
import ComponentMapperBar from '@docs/component-mapper-bar';
3+
import Alert from '@mui/material/Alert';
34

45
<DocPage>
56

67
# MaterialUI mapper
78

89
<ComponentMapperBar prefix="mui" href="https://mui.com/" />
910

11+
<br />
12+
13+
<Alert severity="warning">MUI component mapper is using MUI5. Check the migration guide below.</Alert>
14+
15+
<br />
16+
1017
MaterialUI mapper provides components from [MaterialUI React library](https://mui.com/).
1118

1219
## Installation
@@ -38,17 +45,17 @@ This field will show the error immediately.
3845

3946
## Migration to version 5
4047

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.
48+
MaterialUI (known just as MUI now) 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.
4249

4350
### Migration
4451

4552
#### Convert your app to use MUI 5
4653

4754
Please follow [official migration guide](https://mui.com/guides/migration-v4/). *Note: emotion packages are being installed by the mapper itself.*
4855

49-
#### Use beta version of the mapper
56+
#### Use new version of the mapper
5057

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).)
58+
Use `3.16.0` and higher versions ([check here](https://www.npmjs.com/package/@data-driven-forms/mui-component-mapper).)
5259

5360
<br />
5461

@@ -71,11 +78,11 @@ Please lock your `mui-component-mapper` version in `package.json`:
7178
```diff
7279
# package.json
7380

74-
+ "@data-driven-forms/mui-component-mapper": "^3.15.5",
75-
- "@data-driven-forms/mui-component-mapper": "3.15.5",
81+
- "@data-driven-forms/mui-component-mapper": "^3.15.7",
82+
+ "@data-driven-forms/mui-component-mapper": "3.15.7",
7683
```
7784

78-
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`.)
85+
For any future bug fixes, we will use `3.15.7` as a base version. (example: next bugfix would be `3.15.8` and these versions will be tagged as `deprecated` in the npm registry.)
7986

8087
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.
8188

0 commit comments

Comments
 (0)