fix(core): prevent search button from intercepting browser shortcuts when focused#2871
Open
Sigmabrogz wants to merge 1 commit intoalgolia:mainfrom
Open
fix(core): prevent search button from intercepting browser shortcuts when focused#2871Sigmabrogz wants to merge 1 commit intoalgolia:mainfrom
Sigmabrogz wants to merge 1 commit intoalgolia:mainfrom
Conversation
👷 Deploy request for docsearch pending review.Visit the deploys page to approve it
|
❌ Deploy Preview for docsearch-demo failed.
|
Author
|
This addresses the issue with the search button swallowing browser shortcuts when focused (like DevTools and page reload). |
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.
Summary
Fixes an issue where focusing the
DocSearchButtonand pressing keyboard shortcuts (likeCmd+Opt+Ito open DevTools, orCmd+Rto reload) would be intercepted as a search query, opening the modal and prepopulating the search input with a modifier key name (likeDead,r, etc).Problem
Fixes #2855.
useDocSearchKeyboardEventslistens for key presses globally viawindow.addEventListener('keydown'). It has a helperisEditingContentwhich skips interception if the user is currently focused on anINPUT,TEXTAREA,SELECT, or acontentEditableelement. However, it did not includeBUTTON.When the DocSearch button is focused, typing ANY character is currently captured as the
initialQuery(which is by design so you can just start typing). Unfortunately, this was also capturing chords containing modifier keys (Command/Control/Alt).Solution
Updated the
isEditingContenthelper to also return true if thetagNameisBUTTON. This ensures that standard browser shortcuts (which require thekeydownevent to propagate natively) are not swallowed when the search button happens to be the active element.