Make Tab
insertion optional
#56
Merged
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.
WAI-ARIA recommendations for listboxes only specifies Enter as the key that should insert selected suggestions. Hijacking the Tab key unexpectedly can have negative impacts on user experience, particularly for users who use tabbing to navigate around the page.
At the same time, users may expect Tab to work based on their prior experience with IDEs.
To resolve this, I've added a settings object as a third parameter. In that settings object, the caller can pass a
tabInsertsSuggestions
option to control whether tab inserts suggestions or not. By default it does (to avoid breaking changes) but it can be overridden explicitly.The settings object is fully optional to avoid breaking changes.
See also: second bullet point in this comment primer/react#2157 (comment)