Fixes issue #3059 - scroll to first validation error on BaseForm #3060
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
leplatrem
reviewed
Nov 16, 2023
src/components/BaseForm.tsx
Outdated
| <FormWithTheme | ||
| {...restProps} | ||
| focusOnFirstError={errorFocus} | ||
| error |
There was a problem hiding this comment.
I have no idea why that was there, removed.
Comment on lines
+31
to
+32
| formRef.current | ||
| .querySelector(`[for="root${err.property.replace(/\./g, "_")}"]`) |
There was a problem hiding this comment.
Suggested change
| formRef.current | |
| .querySelector(`[for="root${err.property.replace(/\./g, "_")}"]`) | |
| const fieldName = err.property.replaceAll(".", "_"); | |
| formRef.current | |
| .querySelector(`[for="root${fieldName}"]`) |
This could be fragile since it seems to rely on an internal RSJF naming. Maybe we could add a link to it, I can't find it in upstream source https://github.com/rjsf-team/react-jsonschema-form/blob/main/packages/bootstrap-4/src/FieldErrorTemplate/FieldErrorTemplate.tsx
| return errors; | ||
| }} | ||
| /> | ||
| ); |
There was a problem hiding this comment.
Shall we add a test here to make sure the query selector that we use in the code is found in the page? .querySelector(`[for="root${err.property.replace(/\./g, "_")}"]`)
This way if RJSF changes the way it names its fields, the test would break
There was a problem hiding this comment.
Good call, added
leplatrem
approved these changes
Nov 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue 3059. When a user receives a validation error for a specific property, it will now scroll and center the label for that property in their view.
If an error is thrown for the form rather than a specific property, it will scroll to the top of the form where the full errors list appears.
simplescreenrecorder-2023-11-15_13.41.51.mp4