Skip to content

Commit

Permalink
Release 3.3.0 (#298)
Browse files Browse the repository at this point in the history
* Update dependencies and version text to 3.3.0
* Add regenerated API docs for 3.3.0
* Fix API doc links in doc for available actions
* Add release 3.3.0 news
  • Loading branch information
lucas-koehler authored May 29, 2024
1 parent 64cd763 commit c5c008d
Show file tree
Hide file tree
Showing 808 changed files with 4,604 additions and 4,365 deletions.
12 changes: 6 additions & 6 deletions content/docs/deprecated/available-actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All actions might either be imported directly or via the Actions utility.

## `init(data: any, schema: JsonSchema, uischema: UISchemaElement, options: InitActionOptions | AJV.Ajv)`

<ApiLink link='core/interfaces/initaction.html' title='API' />
<ApiLink link='core/interfaces/Actions.InitAction.html' title='API' />

The INIT action expects the data, schema and UI Schema and initializes the store accordingly.
Currently, this action must be called in order for JSON Forms to work properly.
Expand All @@ -27,7 +27,7 @@ The `options` parameter allows customization of the validator and the ref resolv

## `update(path: string, updater: (existingData: any) => any`

<ApiLink link='core/interfaces/updateaction.html' title='API' />
<ApiLink link='core/interfaces/Actions.UpdateAction.html' title='API' />

The update action is used to update the data substate within the store.
It expects two arguments: a dot-separated path describing which part of the data should be updated as well as a function that returns the value that should be used.
Expand All @@ -36,14 +36,14 @@ The function gets passed the current value that might be used to calculate the u

## `registerRenderer(tester: RankedTester, renderer: any)`

<ApiLink link='core/interfaces/addrendereraction.html' title='API' />
<ApiLink link='core/interfaces/Actions.AddRendererAction.html' title='API' />

This action allows you to register a renderer. It expects two arguments, the 1st being a tester and the 2nd the actual renderer.
Please see the section about [Custom Renderers](/docs/tutorial/custom-renderers) for an example how to use these.

## `registerUISchema(tester: UISchemaTester, uischema: UISchemaElement)`

<ApiLink link='core/interfaces/adduischemaaction.html' title='API' />
<ApiLink link='core/interfaces/Actions.AddUISchemaAction.html' title='API' />

When initializing JSON Forms you have to provide a UISchema. Generally this is already enough as it covers most use cases.
But in some cases, especially when rendering (nested) arrays, you have to provide an UISchema which can be retrieved.
Expand Down Expand Up @@ -80,7 +80,7 @@ You can retrieve a registered UI schema via the `findUISchema` function.

`findUISchema(uischemas: object[], schema: JsonSchema, schemaPath: string, path: string, fallbackLayoutType?: string, control?: ControlElement, rootSchema?: JsonSchema)`

<ApiLink link='core/globals.html#finduischema' title='API' />
<ApiLink link='core/functions/findUISchema.html' title='API' />

To retrieve the registered UI schema you can call the 'findUISchema' function which is provided through the properties.
This function needs the UI Schemas (which consists of a tester and a UI schema), the schema, the schemaPath and a subpath. Optionals parameters are a fallback layout type (`VerticalLayout`by default), a control and the root schema.
Expand Down Expand Up @@ -123,6 +123,6 @@ export const MyControl = ({ data, path, uischemas, schema, onAdd, uischema, find

## `unregisterUISchema(tester: UISchemaTester)`

<ApiLink link='core/globals.html#unregisteruischema' title='API' />
<ApiLink link='core/functions/Actions.unregisterUISchema.html' title='API' />

This action allows to unregister a previously registered UI schema.
14 changes: 14 additions & 0 deletions content/news/2024-05-29-jsonforms-3-3-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
slug: jsonforms-3-3-0
title: JSON Forms 3.3.0
author: JSON Forms
author_image_url: /img/logo.svg
---
We released v3.3.0 🎉.

The release contains various fixes and enhancements across all renderer sets.
Furthermore, the Angular bindings and Angular Material renderer set now support Angular 17 and 18. Support for Angular 16 was dropped.

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

We welcome any feedback of curious users. Any questions? Check out our [community forum](http://jsonforms.discourse.group).
40 changes: 20 additions & 20 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.2.0",
"@jsonforms/examples": "^3.2.0",
"@jsonforms/material-renderers": "^3.2.0",
"@jsonforms/react": "^3.2.0",
"@jsonforms/core": "^3.3.0",
"@jsonforms/examples": "^3.3.0",
"@jsonforms/material-renderers": "^3.3.0",
"@jsonforms/react": "^3.3.0",
"@mdx-js/react": "^3.0.0",
"@mui/icons-material": "^5.11.16",
"@mui/lab": "^5.0.0-alpha.153",
Expand Down
Loading

0 comments on commit c5c008d

Please sign in to comment.