fix: stop the modal docs page from scrolling to the embedded example - #5837
Open
samuelmbabhazi wants to merge 1 commit into
Open
fix: stop the modal docs page from scrolling to the embedded example#5837samuelmbabhazi wants to merge 1 commit into
samuelmbabhazi wants to merge 1 commit into
Conversation
The modal example focuses its first control when it opens, and Firefox scrolls the documentation page down to that element when the example is embedded. Focusing with preventScroll keeps the accessibility behaviour of the standalone examples while leaving the documentation page at the top.
|
samuelmbabhazi is not a collaborator of the repo |
This file contains hidden or 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
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.
Done
preventScroll, so the documentation page no longer scrolls down to the "With footer" example on load. The standalone examples keep focusing the open modal on load, which is the accessibility behaviour that must stay (WCAG SC 2.4.3), and the focus trap and Escape handling are unchangedFixes #5119
QA
/docs/patterns/modalin Firefox: the page stays at the top instead of scrolling to the close button of the "With footer" example/docs/examples/patterns/modal/footer/directly: the close button of the open modal is focused on load, as beforeVerified in headless Firefox 153 and Chromium 151 against a local build: before the change the documentation page loads scrolled 1166px down with the iframe's close button focused, after it the page loads at 0px with the same element focused inside the example.
preventScrollis ignored by browsers that predate it, which simply leaves them with today's behaviour.Check if PR is ready for release
Bug 🐛label (I cannot set labels on this repository)releases.ymlentry: this only touches the documentation example script