Filter error keywords before touch#2540
Conversation
✅ Deploy Preview for jsonforms-examples ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@sdirix @lucas-koehler please review this PR. In the demo app there is a new settings to provide the new config setting which by default is set to an array of one element which is - "required" |
sdirix
left a comment
sdirix
left a comment
There was a problem hiding this comment.
@kchobantonov Thanks for your PR ❤️
For the future I would prefer if you could open more granular PRs. One reason some of your PRs take longer to be merged is because they often span multiple topics. For example if this PR would just contain the location changes, it could have been merged already.
We prefer smaller PRs, separated by topic, if possible.
Yes I understand that but while I was fixing this I noticed the issues with the location and I didn't want to create yet another PR |
…o support filterErrorKeywordsBeforeTouch
|
@sdirix all are fixed except for the useJsonForms() which in another PR as I said I moved that to the vue project - will resolve conflicts once some of those PRs are merged |
sdirix
left a comment
sdirix
left a comment
There was a problem hiding this comment.
Works for me, thanks for the changes.
| const errorsAtControl = | ||
| jsonforms.core?.errors?.filter( | ||
| (error) => input.control.value.path === getControlPath(error), | ||
| ) ?? []; | ||
|
|
||
| // Filter out errors that match the filterKeywords, keep the rest | ||
| const errorsToShow = errorsAtControl.filter( | ||
| (error) => !error.keyword || !filterKeywords.includes(error.keyword), | ||
| ); | ||
| // If no errors were filtered out (all errors remain), return original errors string | ||
| if (errorsToShow.length === errorsAtControl.length) { | ||
| return input.control.value.errors; | ||
| } | ||
|
|
||
| const t = getTranslator()({ jsonforms }); | ||
| const te = getErrorTranslator()({ jsonforms }); | ||
|
|
||
| return getCombinedErrorMessage( | ||
| errorsToShow, | ||
| te, | ||
| t, | ||
| input.control.value.schema, | ||
| input.control.value.uischema, | ||
| input.control.value.path, | ||
| ); |
There was a problem hiding this comment.
We can't change it in this PR but this is a topic for a potential JSON Forms 4.0. We basically repeat what the core mappers do because we need to customize their behavior. The mappers are too feature rich and should be more modular.
3 participants
A new configuration option, filterErrorKeywordsBeforeTouch, allows selective suppression of validation errors before a control is touched, based on AJV error keywords.
This option exists because in most real-world forms, only certain errors—most commonly required—should be hidden prior to user interaction. Other validation errors (such as minLength, pattern, or format) often provide useful guidance and should remain visible immediately.
Instead of hiding all validation errors before interaction, you can now explicitly choose which error types are suppressed and which are shown.
This option is only applied when enableFilterErrorsBeforeTouch is enabled.
If enableFilterErrorsBeforeTouch is false, filterErrorKeywordsBeforeTouch has no effect and all validation errors are shown immediately.
If enableFilterErrorsBeforeTouch is true and filterErrorKeywordsBeforeTouch is not provided, the default behavior applies: no validation errors are shown before the control is touched.
Once the control is touched, all validation errors are always displayed, regardless of these settings.