fix(searchbox): ignore composition events with option #6009
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
We adjusted how
SearchBox
handles input events in #5963 to prevent sending unnecessary search requests during a composition session, mostly occuring with people using input method editors to enter their search query.After release, we received #5986 which was directly linked to the previous adjustment. During our tests, multiple Android target devices initiate composition sessions when typing, if a "predictive text" feature is enabled on a virtual keyboard with a latin character set. This breaks the "search as you type" experience for no reason, as latin characters can be used as-is to refine search queries. This behaviour is not consistent with desktop usage and mobile usage on iOS.
After careful consideration, it seems there is no reliable way to correctly filter-out events within composition sessions in relevant character sets. Instead, this PR sets this behaviour behind a option on the
Searchbox
widget.For example, in InstantSearch.js:
Result
SearchBox
widgetignoreCompositionEvents: true
, input events within a composition session are ignored and won't trigger search requestsFX-2721
Fixes #5986