Fix: Add keyboard and screen reader accessible submenu navigation #309
Conversation
|
Thanks for submitting your first pull request! You are awesome! 🤗 |
|
This is excellent! Thanks so much for the improvement - nobody in the EBP community has strong expertise with accessibility issues so this is much appreciated 🙏 I think the tests are failing because of the regression checks: Each time the tests run, it checks whether the outputs of these files changes: https://github.com/executablebooks/sphinx-book-theme/tree/master/tests/test_build since this changes the sidebar HTML, I think that's why the check is failing. you could update the HTML by deleting the files in that folder that are failing, and running the tests twice (it'll generate the file if no file exists). That said, if this is too much heavy lifting let me know and I can try to push a fix myself to your branch 👍 |
|
@choldgraf - Thanks for the info on the tests, will take a look at sorting them out on this and our other PR later :) |
|
many thanks @IsabelBirds for all of this great work! |
|
What needs to be done to progress this? There's a few other accessibility things I would like to start looking at, but it would be useful if this PR could be merged first? |
|
Right now we're trying to simplify theme as much as possible to inherit structure/features/fixes from the pydata sphinx theme. Check out this PR here: I think this PR is likely too out-of-date to be mergeable at this point. It is sorely needed, but I think that the codebase has changed a lot and it would probably be easier to start from scratch. I'd focus efforts on improving accessibility of the pydata sphinx theme, and we can then inherit here. |
|
Yeah, I saw that, which is why I asked. I'll look into providing some input into the pydata sphinx theme. |
|
I'll close this one so that we can iterate in the pydata theme and inherit here - thanks all for the discussion, and apologies that this one never quite made it to the finish line! |
The current chevron icon solution does not allow keyboard or screen reader users to open their respective menus.
This change surrounds existing icons with button tags and the necessary aria values to explain to screen readers user's what they do.
The sighted mouse user should not be affected.
To test use keyboard alone to navigate to sub menu.
@RobPrecious for queries.