Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify documentation for Control options #2355

Open
TheOneTheOnlyJJ opened this issue Jul 12, 2024 · 1 comment
Open

Unify documentation for Control options #2355

TheOneTheOnlyJJ opened this issue Jul 12, 2024 · 1 comment

Comments

@TheOneTheOnlyJJ
Copy link

TheOneTheOnlyJJ commented Jul 12, 2024

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 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 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

@lucas-koehler
Copy link
Contributor

Hi @TheOneTheOnlyJJ , thank you for the suggestion. It sounds reasonable to me. Would you like to contribute improvements there?

Generally, a quick improvement could be to link the control examples from the documentation page to at least make them easier to discover when reading up on this topic :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants