Remove appending hash behaviour when error summary link clicked #1435
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
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1435
hannalaakso
force-pushed
the
fix-error-summary-focus
branch
from
013de92
to
9279e90
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1435
When error summary links are clicked, this adds a hash to the URL. As reported in #1398, if the form is submitted again with further errors, the hash will stop the error summary being focused as should happen and instead the element with the hash ID is scrolled to which is confusing for the user. This behaviour was prevented in GOV.UK Elements but we were not sure at the time why this was necessary so it wasn't reintroduced in GOV.UK Frontend. As we need to use preventDefault() to stop the page scrolling to the form element itself and to show the error message above to make it clear what happened, we programmatically reintroduced the hash to the URL to replicate browser behaviour. Following the bug report #1398, the code that adds the hash is redundant and can be removed. Co-authored-by: Oliver Byford <[email protected]>
hannalaakso
force-pushed
the
fix-error-summary-focus
branch
from
9279e90
to
b1d0990
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-1435
NickColley
approved these changes
Jun 6, 2019
36degrees
approved these changes
Jun 6, 2019
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.
When error summary links were clicked, a hash with the clicked linked id would be added to the URL. As reported in #1398, if the form is submitted again with further errors, the hash stopped the error summary being focused as should happen, and instead the element with the hash id was scrolled to. This was confusing to the user, especially as they might have already corrected the error in the now focused form element.
This behaviour was prevented in GOV.UK Elements. When the error summary component was added to GOV.UK Frontend, this behaviour wasn't reintroduced as we didn't know the reason for it. We use
preventDefault()to improve the user experience when the error summary links are clicked on by showing the error message above the form field, instead of scrolling down to the form field itself. We programmatically reintroduced the hash to the URL to replicate browser behaviour.Following the bug report, the code for appending the hash is redundant and can be removed.
Fixes #1398