Skip to content

Commit 9edb883

Browse files
Release 3.2.0 (#289)
* update architecture * add release news draft * Update copy docs script and api.mdx * Update docs for Vue 2 removal and updated folder structure * Adapt links for renamed vanilla and material renderer folders * update api docs * Add changelog to news and add news to index page * Upgrade dependencies to 3.2.0 * improve vue vuetify render set docs * fix index news links * vuetify note adaption * adapt renderer set feature table for vue 3 vuetify * remove obsolete vue 2 api doc files * remove obsolete vue2 redirects * remove vue2 references from architecture doc * consistently apply variant 'standard' to demo controls * Apply suggestions from code review --------- Co-authored-by: Stefan Dirix <sdirix@eclipsesource.com>
1 parent d652e76 commit 9edb883

File tree

1,043 files changed

+17980
-103045
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,043 files changed

+17980
-103045
lines changed

content/docs/api.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,5 @@ This section provides links to the API documentation of all available JSON Forms
2020
- <ApiLink link='vanilla/index.html' title='React-based Vanilla renderers' />
2121
- <ApiLink link='angular/index.html' title='Angular integration' />
2222
- <ApiLink link='angular-material/index.html' title='Angular-based Material renderers' />
23-
- <ApiLink link='vue/vue/index.html' title='Vue 3 integration' />
24-
- <ApiLink link='vue/vue-vanilla/index.html' title='Vue 3-based Vanilla renderers' />
25-
- <ApiLink link='vue2/vue2/index.html' title='Vue 2 integration' />
26-
- <ApiLink link='vue2/vue2-vanilla/index.html' title='Vue 2-based Vanilla renderers' />
23+
- <ApiLink link='vue/index.html' title='Vue 3 integration' />
24+
- <ApiLink link='vue-vanilla/index.html' title='Vue 3-based Vanilla renderers' />

content/docs/architecture.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ description: The basic architecture of JSON Forms
1313
The basis of JSON Forms is the core module (`@jsonforms/core`) which provides utilities for managing and rendering JSON Schema based forms.
1414
The core package is independent of any UI technology.
1515

16-
We also provide the JSON Forms React (`@jsonforms/react`), JSON Forms Angular (`@jsonforms/angular`) and JSON Forms Vue (`@jsonforms/vue`, `@jsonforms/vue2`) modules.
16+
We also provide the JSON Forms React (`@jsonforms/react`), JSON Forms Angular (`@jsonforms/angular`) and JSON Forms Vue (`@jsonforms/vue`) modules.
1717
These use the core package to provide specialized bindings for React, Angular and Vue.
1818
This approach is especially useful when developing multiple renderer sets against the same technology (i.e. React) as the core bindings don't need to be reimplemented with each set.
1919

2020
For React we maintain two renderer sets:
2121
The `@jsonforms/material-renderers`, which are based on the popular [Material-UI](https://material-ui.com/) framework and `@jsonforms/vanilla-renderers` which provides pure HTML5 renderers.
22-
For Angular we provide a [Angular Material](https://material.angular.io/) based renderer set (`@jsonforms/angular-material`).
23-
For Vue we provide a HTML5 based renderer set, `@jsonforms/vue-vanilla` for Vue 3, `@jsonforms/vue2-vanilla` for Vue 2 and `@jsonforms/vue2-vuetify` for Vue 2 as well.
22+
For Angular we provide an [Angular Material](https://material.angular.io/) based renderer set (`@jsonforms/angular-material`).
23+
For Vue we provide a HTML5 based renderer set `@jsonforms/vue-vanilla` and a [Vuetify](https://vuetifyjs.com/) based one `@jsonforms/vue-vuetify`.
2424

2525
We put great emphasis on the customizability and extensibility of JSON Forms.
2626
Not only are the existing renderers declaratively configurable, you can also add your own custom renderers or replace existing ones.

content/docs/integrations/vue.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Currently this integration is in a preview state!
1111
:::
1212

1313
With version 2.5 of JSON Forms we added support for Vue 2 (`@jsonforms/vue2`) and Vue 3 (`@jsonforms/vue`).
14-
Support for Vue 2 will be phased out once the community moves on.
14+
Support for Vue 2 was dropped with JSON Forms 3.2.
15+
The last official release containing Vue 2 is [v3.1.0](https://github.com/eclipsesource/jsonforms/tree/v3.1.0).
1516

16-
For Vue we provide a HTML5 based renderer set, `@jsonforms/vue-vanilla` for Vue 3 and `@jsonforms/vue2-vanilla` for Vue 2.
17-
Additionally we offer a [jsonforms-vue-seed](https://github.com/eclipsesource/jsonforms-vue-seed), which allows to get a quick start with our Vue integration.
18-
By default the seed is based on Vue 3.
19-
The Vue 2 variant can be found on the [`vue2` branch](https://github.com/eclipsesource/jsonforms-vue-seed/tree/vue2).
17+
For Vue we provide a HTML5 based renderer set, `@jsonforms/vue-vanilla` for Vue 3.
18+
There also is the Vuetify-based renderer set `@jsonforms/vue-vuetify`. Note that this is currently in a preview state.
19+
Additionally, we offer a [jsonforms-vue-seed](https://github.com/eclipsesource/jsonforms-vue-seed), which allows to get a quick start with our Vue integration.
2020

21-
For further information on how to use JSON Forms Vue and how to write an own renderer set, please consult the README.md files for the [Vue 3](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue/vue/README.md) and [Vue 2](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue2/vue2/README.md) bindings as well as the [Vue 3 vanilla](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue/vue-vanilla/README.md), the [Vue 2 vanilla](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue2/vue2-vanilla/README.md) and the [Vue 2 Vuetify](https://github.com/eclipsesource/jsonforms-vuetify-renderers/blob/main/vue2-vuetify/README.md) renderer sets.
21+
For further information on how to use JSON Forms Vue and how to write an own renderer set, please consult the README.md files for the [Vue](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue/README.md) bindings as well as the [Vue vanilla](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue-vanilla/README.md) and the [Vue Vuetify](https://github.com/eclipsesource/jsonforms-vuetify-renderers/blob/vue3/vue-vuetify/README.md) renderer sets.

content/docs/renderer-sets.mdx

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,19 @@ The Angular Material UI Renderer Set is based on [Angular Material](https://mate
3131
## Vue Vanilla Renderer Set
3232

3333
The Vue Renderer Set is based on plain HTML with a set of custom styles.
34-
For more information, see the [Vue Vanilla Readme](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue/vue-vanilla/README.md).
34+
For more information, see the [Vue Vanilla Readme](https://github.com/eclipsesource/jsonforms/blob/master/packages/vue-vanilla/README.md).
3535

36-
## Vue2 Vuetify Renderer Set
36+
## Vue Vuetify Renderer Set
3737

38-
The Vue2 Vuetify Set provides a Vuetify based renderer set for JSON Forms Vue 2.
38+
The Vue Vuetify Set provides a Vuetify based renderer set for JSON Forms.
3939
It's not part of the main repository, but lives in its own repository:
4040
https://github.com/eclipsesource/jsonforms-vuetify-renderers
4141

42-
For more information, see the [Vue2 Vuetify Readme](https://github.com/eclipsesource/jsonforms-vuetify-renderers/blob/main/vue2-vuetify/README.md).
42+
:::info Note
43+
44+
Please note that the Vue Vuetify renderer set is in a preview state and has known bugs.
45+
We are happy to accept contributions to improve its quality.
46+
47+
:::
48+
49+
For more information, see the [Vue Vuetify Readme](https://github.com/eclipsesource/jsonforms-vuetify-renderers/tree/vue3/vue-vuetify/README.md).
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
slug: jsonforms-3-2-0
3+
title: JSON Forms 3.2.0
4+
author: JSON Forms
5+
author_title: Twitter
6+
author_url: https://twitter.com/jsonforms
7+
author_image_url: /img/logo.svg
8+
---
9+
We released v3.2.0 🎉. Besides various fixes and improved developer tooling, this release adds middleware support to all bindings. This makes it a breeze to hook into data updates!
10+
11+
With this release, the Angular bindings and Angular Material renderer set now support Angular 16 and 17. Special thanks to [JBBianchi](https://github.com/JBBianchi) for contributing this massive upgrade.
12+
13+
You can find the full changelog in the [Github release](https://github.com/eclipsesource/jsonforms/releases/tag/v3.2.0).
14+
15+
We welcome any feedback of curious users. Any questions? Check out our [community forum](http://jsonforms.discourse.group).

content/pages/index.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,15 @@ function Home() {
107107
<section className={styles.sectionNews}>
108108
<Card className={styles.newsCard}>
109109
<CardContent>
110-
Great news! We are in the final stretches of the long awaited JSON Forms 3.0 release. Today we published the release candidate "3.0.0-rc.0" 🎉
110+
We released v3.2.0 🎉. Besides various fixes and improved developer tooling, this release adds middleware support to all bindings. This makes it a breeze to hook into data updates!
111111
<br/>
112-
We welcome any feedback of curious users. Any questions? Check out our community forum <a href="https://jsonforms.discourse.group">jsonforms.discourse.group</a>.
112+
With this release, the Angular bindings and Angular Material renderer set now support Angular 16 and 17. Special thanks to <a href="https://github.com/JBBianchi">JBBianchi</a> for contributing this massive upgrade.
113+
<br />
114+
You can find the full changelog in the <a href="https://github.com/eclipsesource/jsonforms/releases/tag/v3.2.0">Github release</a>.
115+
<br />
116+
We welcome any feedback of curious users. Any questions? Check out our <a href="http://jsonforms.discourse.group">community forum</a>. See also our <a href="https://github.com/eclipsesource/jsonforms/blob/master/MIGRATION.md">migration guide</a>.
113117
<br/>
114-
<span style={{ display: 'block', textAlign: 'right', width: '100%'}}>25th July 2022</span>
118+
<span style={{ display: 'block', textAlign: 'right', width: '100%'}}>24th January 2024</span>
115119
</CardContent>
116120
</Card>
117121
<Link to='/news' className={styles.newsButton}>

copy-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
WEBSITE_REPO=$( dirname "${BASH_SOURCE[0]}" )
33
JSONFORMS_REPO=$1
4-
declare -a PACKAGES=(core react material vanilla angular angular-material vue/vue vue2/vue2 vue/vue-vanilla vue2/vue2-vanilla)
4+
declare -a PACKAGES=(core react material-renderers vanilla-renderers angular angular-material vue vue-vanilla)
55

66
if [[ -z $JSONFORMS_REPO || ! -d $JSONFORMS_REPO ]]; then
77
echo "Error: please specify JSONForms source repo location."

netlify.toml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,6 @@
2525
from = "/public/api/vue/*"
2626
to = "/api/vue/"
2727

28-
[[redirects]]
29-
from = "/public/api/vue2/*"
30-
to = "/api/vue2/"
31-
3228
[[headers]]
3329
for = "/*"
3430
[headers.values]

package-lock.json

Lines changed: 33 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@
2424
"@easyops-cn/docusaurus-search-local": "^0.40.1",
2525
"@emotion/react": "^11.11.3",
2626
"@emotion/styled": "^11.11.0",
27-
"@jsonforms/core": "^3.1.0",
28-
"@jsonforms/examples": "^3.1.0",
29-
"@jsonforms/material-renderers": "^3.1.0",
30-
"@jsonforms/react": "^3.1.0",
27+
"@jsonforms/core": "^3.2.0",
28+
"@jsonforms/examples": "^3.2.0",
29+
"@jsonforms/material-renderers": "^3.2.0",
30+
"@jsonforms/react": "^3.2.0",
3131
"@mdx-js/react": "^3.0.0",
3232
"@mui/icons-material": "^5.11.16",
3333
"@mui/lab": "^5.0.0-alpha.153",

src/components/common/Demo.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,21 @@ const theme = createTheme({
1717
root: {
1818
margin: '0.8em 0',
1919
},
20+
},
21+
defaultProps: {
22+
variant: 'standard'
2023
}
2124
},
25+
MuiTextField: {
26+
defaultProps: {
27+
variant: 'standard'
28+
}
29+
},
30+
MuiSelect: {
31+
defaultProps: {
32+
variant: 'standard'
33+
}
34+
}
2235
},
2336
});
2437

src/components/docs/renderer-sets.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export const RendererSetSchemaFeatureTable = () => (
3131
<TableCell>Angular Material</TableCell>
3232
<TableCell>React Vanilla</TableCell>
3333
<TableCell>Vue Vanilla</TableCell>
34-
<TableCell>Vue2 Vuetify</TableCell>
34+
<TableCell>Vue Vuetify</TableCell>
3535
</TableRow>
3636
</TableHead>
3737
<TableBody>
@@ -250,7 +250,7 @@ export const RendererSetUISchemaFeatureTable = () => (
250250
<TableCell>Angular Material</TableCell>
251251
<TableCell>React Vanilla</TableCell>
252252
<TableCell>Vue Vanilla</TableCell>
253-
<TableCell>Vue2 Vuetify</TableCell>
253+
<TableCell>Vue Vuetify</TableCell>
254254
</TableRow>
255255
</TableHead>
256256
<TableBody>

static/api/angular-material/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

0 commit comments

Comments
 (0)