Skip to content

Commit

Permalink
Release 3.2.0 (#289)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
lucas-koehler and sdirix authored Jan 24, 2024
1 parent d652e76 commit 9edb883
Show file tree
Hide file tree
Showing 1,043 changed files with 17,980 additions and 103,045 deletions.
6 changes: 2 additions & 4 deletions content/docs/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,5 @@ This section provides links to the API documentation of all available JSON Forms
- <ApiLink link='vanilla/index.html' title='React-based Vanilla renderers' />
- <ApiLink link='angular/index.html' title='Angular integration' />
- <ApiLink link='angular-material/index.html' title='Angular-based Material renderers' />
- <ApiLink link='vue/vue/index.html' title='Vue 3 integration' />
- <ApiLink link='vue/vue-vanilla/index.html' title='Vue 3-based Vanilla renderers' />
- <ApiLink link='vue2/vue2/index.html' title='Vue 2 integration' />
- <ApiLink link='vue2/vue2-vanilla/index.html' title='Vue 2-based Vanilla renderers' />
- <ApiLink link='vue/index.html' title='Vue 3 integration' />
- <ApiLink link='vue-vanilla/index.html' title='Vue 3-based Vanilla renderers' />
6 changes: 3 additions & 3 deletions content/docs/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ description: The basic architecture of JSON Forms
The basis of JSON Forms is the core module (`@jsonforms/core`) which provides utilities for managing and rendering JSON Schema based forms.
The core package is independent of any UI technology.

We also provide the JSON Forms React (`@jsonforms/react`), JSON Forms Angular (`@jsonforms/angular`) and JSON Forms Vue (`@jsonforms/vue`, `@jsonforms/vue2`) modules.
We also provide the JSON Forms React (`@jsonforms/react`), JSON Forms Angular (`@jsonforms/angular`) and JSON Forms Vue (`@jsonforms/vue`) modules.
These use the core package to provide specialized bindings for React, Angular and Vue.
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.

For React we maintain two renderer sets:
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.
For Angular we provide a [Angular Material](https://material.angular.io/) based renderer set (`@jsonforms/angular-material`).
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.
For Angular we provide an [Angular Material](https://material.angular.io/) based renderer set (`@jsonforms/angular-material`).
For Vue we provide a HTML5 based renderer set `@jsonforms/vue-vanilla` and a [Vuetify](https://vuetifyjs.com/) based one `@jsonforms/vue-vuetify`.

We put great emphasis on the customizability and extensibility of JSON Forms.
Not only are the existing renderers declaratively configurable, you can also add your own custom renderers or replace existing ones.
Expand Down
12 changes: 6 additions & 6 deletions content/docs/integrations/vue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Currently this integration is in a preview state!
:::

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

For Vue we provide a HTML5 based renderer set, `@jsonforms/vue-vanilla` for Vue 3 and `@jsonforms/vue2-vanilla` for Vue 2.
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.
By default the seed is based on Vue 3.
The Vue 2 variant can be found on the [`vue2` branch](https://github.com/eclipsesource/jsonforms-vue-seed/tree/vue2).
For Vue we provide a HTML5 based renderer set, `@jsonforms/vue-vanilla` for Vue 3.
There also is the Vuetify-based renderer set `@jsonforms/vue-vuetify`. Note that this is currently in a preview state.
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.

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.
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.
15 changes: 11 additions & 4 deletions content/docs/renderer-sets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,19 @@ The Angular Material UI Renderer Set is based on [Angular Material](https://mate
## Vue Vanilla Renderer Set

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

## Vue2 Vuetify Renderer Set
## Vue Vuetify Renderer Set

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

For more information, see the [Vue2 Vuetify Readme](https://github.com/eclipsesource/jsonforms-vuetify-renderers/blob/main/vue2-vuetify/README.md).
:::info Note

Please note that the Vue Vuetify renderer set is in a preview state and has known bugs.
We are happy to accept contributions to improve its quality.

:::

For more information, see the [Vue Vuetify Readme](https://github.com/eclipsesource/jsonforms-vuetify-renderers/tree/vue3/vue-vuetify/README.md).
15 changes: 15 additions & 0 deletions content/news/2024-01-24-jsonforms-3-2-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
slug: jsonforms-3-2-0
title: JSON Forms 3.2.0
author: JSON Forms
author_title: Twitter
author_url: https://twitter.com/jsonforms
author_image_url: /img/logo.svg
---
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!

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.

You can find the full changelog in the [Github release](https://github.com/eclipsesource/jsonforms/releases/tag/v3.2.0).

We welcome any feedback of curious users. Any questions? Check out our [community forum](http://jsonforms.discourse.group).
10 changes: 7 additions & 3 deletions content/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,15 @@ function Home() {
<section className={styles.sectionNews}>
<Card className={styles.newsCard}>
<CardContent>
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" 🎉
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!
<br/>
We welcome any feedback of curious users. Any questions? Check out our community forum <a href="https://jsonforms.discourse.group">jsonforms.discourse.group</a>.
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.
<br />
You can find the full changelog in the <a href="https://github.com/eclipsesource/jsonforms/releases/tag/v3.2.0">Github release</a>.
<br />
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>.
<br/>
<span style={{ display: 'block', textAlign: 'right', width: '100%'}}>25th July 2022</span>
<span style={{ display: 'block', textAlign: 'right', width: '100%'}}>24th January 2024</span>
</CardContent>
</Card>
<Link to='/news' className={styles.newsButton}>
Expand Down
2 changes: 1 addition & 1 deletion copy-docs.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
WEBSITE_REPO=$( dirname "${BASH_SOURCE[0]}" )
JSONFORMS_REPO=$1
declare -a PACKAGES=(core react material vanilla angular angular-material vue/vue vue2/vue2 vue/vue-vanilla vue2/vue2-vanilla)
declare -a PACKAGES=(core react material-renderers vanilla-renderers angular angular-material vue vue-vanilla)

if [[ -z $JSONFORMS_REPO || ! -d $JSONFORMS_REPO ]]; then
echo "Error: please specify JSONForms source repo location."
Expand Down
4 changes: 0 additions & 4 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@
from = "/public/api/vue/*"
to = "/api/vue/"

[[redirects]]
from = "/public/api/vue2/*"
to = "/api/vue2/"

[[headers]]
for = "/*"
[headers.values]
Expand Down
63 changes: 33 additions & 30 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
"@easyops-cn/docusaurus-search-local": "^0.40.1",
"@emotion/react": "^11.11.3",
"@emotion/styled": "^11.11.0",
"@jsonforms/core": "^3.1.0",
"@jsonforms/examples": "^3.1.0",
"@jsonforms/material-renderers": "^3.1.0",
"@jsonforms/react": "^3.1.0",
"@jsonforms/core": "^3.2.0",
"@jsonforms/examples": "^3.2.0",
"@jsonforms/material-renderers": "^3.2.0",
"@jsonforms/react": "^3.2.0",
"@mdx-js/react": "^3.0.0",
"@mui/icons-material": "^5.11.16",
"@mui/lab": "^5.0.0-alpha.153",
Expand Down
13 changes: 13 additions & 0 deletions src/components/common/Demo.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,21 @@ const theme = createTheme({
root: {
margin: '0.8em 0',
},
},
defaultProps: {
variant: 'standard'
}
},
MuiTextField: {
defaultProps: {
variant: 'standard'
}
},
MuiSelect: {
defaultProps: {
variant: 'standard'
}
}
},
});

Expand Down
4 changes: 2 additions & 2 deletions src/components/docs/renderer-sets.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const RendererSetSchemaFeatureTable = () => (
<TableCell>Angular Material</TableCell>
<TableCell>React Vanilla</TableCell>
<TableCell>Vue Vanilla</TableCell>
<TableCell>Vue2 Vuetify</TableCell>
<TableCell>Vue Vuetify</TableCell>
</TableRow>
</TableHead>
<TableBody>
Expand Down Expand Up @@ -250,7 +250,7 @@ export const RendererSetUISchemaFeatureTable = () => (
<TableCell>Angular Material</TableCell>
<TableCell>React Vanilla</TableCell>
<TableCell>Vue Vanilla</TableCell>
<TableCell>Vue2 Vuetify</TableCell>
<TableCell>Vue Vuetify</TableCell>
</TableRow>
</TableHead>
<TableBody>
Expand Down
1 change: 1 addition & 0 deletions static/api/angular-material/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +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.
Loading

0 comments on commit 9edb883

Please sign in to comment.