eclipsesource / eclipsesource/jsonforms

Unify documentation for Control options

Open
#2,355 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
2.7k
Forks
424
Avg merge
17d 8h
Merged PRs (30d)
1

Description

### Is your feature request related to a problem? Please describe.

This issue is strictly about the documentation found at https://jsonforms.io/docs/uischema/controls and at https://jsonforms.io/examples/control.

On the docs page (first link), the [Options](https://jsonforms.io/docs/uischema/controls#options) section covers the following Control options:

- detail
- showSortButtons
- elementLabelProp
- format
- readonly

However, one has to go to the examples page (second link) to discover the rest of the available Control options. The options covered here are:

- multi
- slider
- trim
- restrict
- showUnfocusedDescription
- hideRequiredAsterisk
- toggle

As I was researching how to build a form, I remembered seeing the slider option. I wanted to see how to specify this option in the UI Schema, but I found myself being unable to find it intuitively in the docs. I sifted through all the docs pages without luck, only to find the option mentioned in the examples page at a later date.

### Describe the solution you'd like

I suggest covering all options in the proper docs page (first link) and hyperlinking them to the examples page (second link) so as to not clutter the docs page with examples. This way, everybody who reads the docs page will be made aware of all possible Control options. Furthermore, the rest of the examples from the docs page (first link), such as the [Radio groups](https://jsonforms.io/docs/uischema/controls#radio-groups-format-radio) example, should be moved to the examples page (second link) to maintain consistency with the other available options. The examples page could be broken up into sections for convenient hyperlinking with the docs page.

### Describe alternatives you've considered

None.

### Framework

_No response_

### RendererSet

_No response_

### Additional context

Documentation

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.