eclipsesource / eclipsesource/jsonforms
Unify documentation for Control options
- 主要言語
- TypeScript
- スター
- 2.7k
- フォーク
- 424
- 平均マージ
- 17日 8時間
- マージ済み PR(30日)
- 1
説明
### 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
コントリビューションガイド
調査の方向性
jsonforms.io/docs/uischema/controls の「Control options」セクションから始め、jsonforms.io/examples/control と比較します。オプションと既存の例を一覧化し、そのうえでドキュメントがすべてのオプションを網羅してリンクしていること、また例のページがリンク可能なセクションに整理されていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100