json-schema-form
Potential improvement to always show title, description, key
Enhancement
As a user/developer, when I am filling in a field on the interface I should be able to perhaps optionally, be always able to see the title, description, key, and any validation error
Expected behaviour
I expected when making a mistake on a certain field in the gui, for the description to be always visible as it often gives clues as to how to make the field valid
Actual behaviour
It actually shows the validation error message and the description is hidden. For fields that have some sort of complicated regex, the description field is often the best place to place a description of how to make the field valid, but if a field is invalid, and is also required, I am unable to get the description to appear again once its gone into an invalid field state.
I'm just putting this forward as an idea, that I think in general it should be possible to have
- The title and key always visible. For our tool which is being used by developers themselves, we want to be able to always allow them to see both the title and key name. Currently we can only see a way to show on or the other, not both.
- As I mentioned, when we make a mistake on a field, I think the description should be left as is and not hidden, and for the error message to appear in one line below perhaps, so that the description is always visible.
Do you think these would be good improvements?
@json-schema-form/angular-schema-form-lead
@mark007 I'm all for it :) If it was still in the page then it could be forced to continue displaying with css. To be honest the description field itself is contentious to me as it is part of the json-schema designed for describing a field and for some reason is found within the validation schema, there is discussion about adding a hint field to the schema for what we use description for. There is another discussion about moving it to the core schema so every other schema could define its usage. Anyway, I am considering adding a hint field to behave similar to what you suggested here, just have to find the time, or have a PR for it :)
