Skip to content

Commit d791185

Browse files
chore: update migration guide and readmes
- remove the 3.0 migration warning from @jsonforms/core - add more information to migration guide in regards to Angular 16/17 - update JSON Forms component props information in all binding readmes Co-authored-by: Lucas Koehler <[email protected]>
1 parent 442742e commit d791185

File tree

5 files changed

+19
-10
lines changed

5 files changed

+19
-10
lines changed

MIGRATION.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Migrating to JSON Forms 3.2
44

5-
### Material Renderers using Outlined Inputs
5+
### React Material Renderers using Outlined Inputs
66

77
JSON Forms now uses the `outlined` input variant as the default, aligning with the default style of Material UI since version 5.
88
If you would like to use the `standard` input variant, as was default in previous versions of JSON Forms, then this can be accomplished using the Material UI `ThemeProvider`:
@@ -38,6 +38,16 @@ const theme = createTheme({
3838
</ThemeProvider>;
3939
```
4040

41+
### Angular support now targets Angular 16 and Angular 17
42+
43+
When using JSON Forms 3.2, your Angular application now needs to target Angular 16 or 17.
44+
Some refactorings, especially in Angular Material, were necessary to accomplish this.
45+
46+
Use JSON Forms 3.1 if you need to stay on Angular 14.
47+
48+
> [!NOTE]
49+
> Angular 15 is only supported by the JSON Forms prerelease `3.2.0-alpha.4`.
50+
4151
## Migrating to JSON Forms 3.0
4252

4353
### Additional parameter for testers

packages/angular/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ Optional props:
3232
- `uischemas: JsonFormsUiSchemaEntry[]` - registry for dynamic ui schema dispatching
3333
- `validationMode: 'ValidateAndShow' | 'ValidateAndHide' | 'NoValidation'` - the validation mode for the form
3434
- `ajv: AJV` - custom Ajv instance for the form
35-
- `locale` - string, for example for formatting numbers
35+
- `middleware: Middleware` - can be used to hook into the form-wide data management.
36+
- `i18n: JsonFormsI18nState` - can be used to internationalize the rendered form.
3637
- `dataChange` - event emitter which is called on each data change, containing the updated data and the validation result.
3738
- `errors` - event emitter which is called with all validations errors.
3839

packages/core/README.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,10 @@ The following seeds are available:
1818
- [Angular Seed](https://github.com/eclipsesource/jsonforms-angular-seed)
1919
- [Vue Seed](https://github.com/eclipsesource/jsonforms-vue-seed)
2020

21-
See the official [documentation](https://jsonforms.io/) and the [Example Package](https://github.com/eclipsesource/jsonforms/blob/master/packages/examples) on how to integrate JSON Forms with your application.
21+
See the official [documentation](https://jsonforms.io/) for more information.
2222

2323
Check <https://www.npmjs.com/search?q=%40jsonforms> for all published JSON Forms packages.
2424

25-
## Upgrading to JSON Forms 3.0
26-
27-
With version 3.0 of JSON Forms we removed `json-schema-ref-parser` from the core package.
28-
This change only affects users of the React variant (Vue and Angular are not affected) and even for React only a few users will need to adjust their code.
29-
To avoid issues and for more information, please have a look at our [migration guide](https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md).
30-
3125
## License
3226

3327
The JSON Forms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.

packages/react/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ Optional props:
3333
- `uischemas: JsonFormsUiSchemaEntry[]` - registry for dynamic ui schema dispatching
3434
- `validationMode: 'ValidateAndShow' | 'ValidateAndHide' | 'NoValidation'` - the validation mode for the form
3535
- `ajv: AJV` - custom Ajv instance for the form
36-
- `onChange` - callback which is called on each data change, containing the updated data and the validation result.
36+
- `middleware: Middleware` - can be used to hook into the form-wide data management.
37+
- `i18n: JsonFormsI18nState` - can be used to internationalize the rendered form.
38+
- `onChange` - callback which is called initially and on each data change, containing the updated data and the validation result.
3739

3840
Example:
3941

packages/vue/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Optional props:
3131
- `uischemas: JsonFormsUiSchemaEntry[]` - registry for dynamic ui schema dispatching
3232
- `validationMode: 'ValidateAndShow' | 'ValidateAndHide' | 'NoValidation'` - the validation mode for the form
3333
- `ajv: AJV` - custom Ajv instance for the form
34+
- `middleware: Middleware` - can be used to hook into the form-wide data management.
35+
- `i18n: JsonFormsI18nState` - can be used to internationalize the rendered form.
3436

3537
Events:
3638

0 commit comments

Comments
 (0)