Fix accessibility regression and further improvements #96
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
Since the result div IDs are simply using to the index number, the value in aria-activedescendant might not change, which results in screen readers not reading the selected option even if the value inside it has changed. For example, with disableAutoSelect=true, type anything and press Down. The first option is selected and read. When then continuing to type and pressing Down again, the first option is selected, but not read, since aria-activedescendant has not changed. This commit resets the value of the attribute. That means there is a change in the ID in both cases, and the options are read. However, for disableAutoSelect=false, the problem still exists.
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
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.
This PR makes a few changes regarding accessibility. The module has been tested with the Orca screen reader on Linux.
aria-attributes made a small mistake by using the attributearia-roleinstead ofrole. The latter is the standard, the former does not exist. This resulted in a major regression in accessibility, as Orca would immediately switch away from focus mode back into browse mode when using the input (where most letters function as buttons to navigate the page, making it impossible to type anything). All occurences ofaria-rolehave been replaced byroleand now function correctly.aria-activedescendant, which handles the currently selected option and makes the screen reader speak out that option when changed. However, due to how the IDs for the option divs are set, it was possible to receive changed suggestions, but have an option with the same ID selected, which resulted in no text being read out. To solve this, a string hash on the query string has been added into the IDs to ensurearia-activedescendantis updated when new results might be available. The div foremptyMsghas also been given a similar ID to allow screen readers to read it out.aria-attributes were added -aria-ownsto mark the ownership relation in addition to the cause-and-effect relation, andaria-haspopupto make the screen reader tell the user that the input will open a listbox when used.