-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
fix: focus-trap on safari #23246
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+87
−34
Merged
fix: focus-trap on safari #23246
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you give some info on what does sentinel node mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The shift-tab key binding is not observable in browsers. Browsers do not send the shift-tab keyDown combination to javascript code -- which meant that the current focus-trap implementation was not working properly. This was not detected by the test, because the shift-tab unit test had a typo in it.
The common solution to this problem used by other focus trap libraries is to insert two "marker elements" - one at the beginning of the trap and one at the end - I'm naming these sentinel nodes, because there job is to listen/watch to the 'focus' event (instead of shift-tab).
When the startSentinel element gets focus, it will set focus to the last focusable element. When the lastSentinel element gets focus, it will set focus to the first focusable element, thereby completing the trap.
In the case that there are no focusable elements, a backupSentinel element is inserted - the sole purpose of this element is to accept focus when there are no other elements available to focus. This is useful when, a modal without any input fields is open, but you still want to prevent focus from leaving the modal until it is dismissed.