Fix autocomplete keyboard control on Windows/Edge #170
Conversation
This file contains 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
kochis
changed the title
jaspk06
reviewed
Jun 27, 2024
src/ui/autocomplete.ts
Outdated
| @@ -136,6 +132,10 @@ class AutocompleteUI { | |||
| // result list element | |||
| this.resultsList = document.createElement('ul'); | |||
| this.resultsList.classList.add(CLASSNAMES.RESULTS_LIST); | |||
| this.resultsList.classList.add('id', CLASSNAMES.RESULTS_LIST); | |||
There was a problem hiding this comment.
Suggested change
| this.resultsList.classList.add('id', CLASSNAMES.RESULTS_LIST); | |
| this.resultsList.setAttribute('id', CLASSNAMES.RESULTS_LIST); |
src/ui/autocomplete.ts
Outdated
| @@ -275,6 +283,8 @@ class AutocompleteUI { | |||
| results.forEach((result, index) => { | |||
| const li = document.createElement('li'); | |||
| li.classList.add(CLASSNAMES.RESULTS_ITEM); | |||
| li.setAttribute('role', 'option'); | |||
| li.setAttribute('id', `item-${index}`); | |||
There was a problem hiding this comment.
fyi we use the same class value for both class and id attributes for the input element but different values for this lielement. Should this be
Suggested change
| li.setAttribute('id', `item-${index}`); | |
| li.setAttribute('id', `${CLASSNAMES.RESULTS_ITEM}-${index}`); |
to make it more consistent?
There was a problem hiding this comment.
we should prob make this ${CLASSNAMES.RESULTS_ITEM}-${index} since id attributes should be unique. item-${index} might cause issues with existing ids
src/ui/autocomplete.ts
Outdated
| @@ -380,43 +391,41 @@ class AutocompleteUI { | |||
| // add class name to newly highlighted item | |||
| resultItems[index].classList.add(CLASSNAMES.SELECTED_ITEM); | |||
|
|
|||
| // set aria active descendant | |||
| this.inputField.setAttribute('aria-activedescendant', `item-${index}`); | |||
There was a problem hiding this comment.
and if we wanna go with the above suggestion
Suggested change
| this.inputField.setAttribute('aria-activedescendant', `item-${index}`); | |
| this.inputField.setAttribute('aria-activedescendant', `${CLASSNAMES.RESULTS_ITEM}-${index}`); |
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.
The main fix is to change from
event.codetoevent.keyfor handling keyboard events, which was breaking on Windows/Edge.Other enhancements are additional aria-roles for accessibility.