Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve accessibility in the search UI #772

Open
SeanFarrow opened this issue Jul 11, 2023 · 5 comments
Open

Improve accessibility in the search UI #772

SeanFarrow opened this issue Jul 11, 2023 · 5 comments

Comments

@SeanFarrow
Copy link

Whilst the search UI works for screen readers, it could definitely be improved with the following changes:
Firstly, make the "Search" combobox a required field.
Secondly, there is no easy way of navigating through results. I ended up tabbing though links, but it is then unclear when a new search result refers to a different library.
Finally, could this be made a modal dialog. Screen readers have two ways of navigating the web.
One essentially "flattens" the page in to a buffer so it can be read easily. Tyhe other, which is what we are dealing with here is used in a "live environment" where you have contents that change.

To fix this, we should either have a set of headings for each library the search has found, or have the user actually click a search button rather than the search being automatic.

@vinniefalco
Copy link
Member

Thanks for opening this issue! Is there perhaps another existing deployment of the Algolia UI that is already tuned for screen readers that we can simply copy?

@SeanFarrow
Copy link
Author

SeanFarrow commented Jul 11, 2023 via email

@ashtum
Copy link
Contributor

ashtum commented Jul 11, 2023

Thank you for reporting this issue.
The related code for the UI is here: https://github.com/cppalliance/boost-gecko/tree/develop/lab/search_interface
It is a react app that uses Material UI and Algolia react library to create the search interface.
Did you experience the same issues on a specific library page too? like https://www.boost.org/doc/libs/1_82_0/doc/html/boost_asio.html.
I have created an issue for grouping the results for each library when the search is targeting all libraries.
We can add labels if that helps.

@ashtum
Copy link
Contributor

ashtum commented Jul 11, 2023

Finally, could this be made a modal dialog

It uses a material UI dialog component: https://mui.com/material-ui/react-dialog/.
Which I think is equivalent to modal in other UI frameworks.

@SeanFarrow
Copy link
Author

SeanFarrow commented Jul 11, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants