Problem/Motivation
This is a Plan/Meta issue that will gather a list of other other issues and does not expect any code/MR.
This issue is where we'll start collecting the accessibility issues we find and where we'll prioritize them. Please follow the process below so we can keep track of what is needed.
- Test the latest version of the Navigation module using the Tugboat environment following the defined protocol
- Create an independent issue child of this one
- Copy and paste the issue summary template
- Explain the problem found and if you know it, a proposed resolution
- Add this issue as parent
- Add easy to understand instructions on how to reproduce the issue
- Add this issue under the Issues found section on this page
Issue Summary Template
<h3 id="summary-problem-motivation">Problem/Motivation</h3>
<h4 id="summary-wcag-success-criteria">WCAG success criteria</h4>
Add embedded link to WCAG 2.2 success criteria understanding doc from https://www.w3.org/WAI/WCAG22/Understanding/
<h4 id="summary-related-technique">Related technique</h4>
Optionally add embedded link to WCAG 2.2 related technique from understanding doc at https://www.w3.org/WAI/WCAG22/Understanding/
<h4 id="summary-steps-reproduce">Steps to reproduce</h4>
<h4 id="summary-code-snippet">Code snippet</h4>
<h3 id="summary-proposed-resolution">Proposed resolution</h3>
Protocol
Draft protocol to follow on testing, pending to define a more completed one:
Testing site
WCAG 2.2 success criteria to test against
Review and make updates to the Google sheet containing WCAG 2.2 Level AA success criteria that apply to this testing. Existing tickets have been added to the sheet.
Testing tool resources
- 48 Browser Extensions to Perform Accessibility Testing Effectively
- How Cool Accessibility Tools Can Make Your Life Easier
- Web Accessibility Evaluation Tools List
Front-end
- Collapse/expand the sidebar
- Scroll the sidebar (if the “content” is higher than the viewport height + footer)
- Open/Close the drawer on hover (submenu level 2)
- Test it with edge cases, like moving fast to the top of the drawer - so the mouse leaves the targeted hover item
- Navigate to submenu level 3 (accordion)
- Navigate to User menu links
- See labels/tooltips of the 1st level links
- Active menu item on 1st, 2nd and 3rd level items
- (If logo) it takes you to the homepage
- Active item shows as so in the Toolbar
Admin UI pages
- Modify menus in
admin/config/user-interface/navigation-block- Add new menu block
- Modify a menu block
- Hide / show the title for menu block
- Remove menu block
- Remove menu block
- Navigation settings in
admin/config/user-interface/navigation/settings- Hide the logo. #3443556: Enhance Navigation admin workflow with Managed Tabs. consider removing. logo is a landmark feature.
- Use a custom logo
- Note: the Top Bar is not ready to be tested yet.
Success criteria
The goal is to comply with Drupal core accessibility gates. One exception is that the WCAG 2.2 Level AA standards should be used for all testing. Currently supported browser requirements in core should also be followed.
Issues found
Really should have (higher priority)
None noted yet.
Should have
- #3426468: Make the active menu item visually stand out more
- #3439721: Make the link descriptions more descriptive, helpful, and clear.
- #3541688: Focus does not move to submenu when opened by enter or space key
- #3541728: Submenu opened with hover does not close by Escape key when another menu item has focus (Major)
- #3396174: The toolbar should be usable without JS
- #3443556: Enhance Navigation admin workflow with Managed Tabs.
- #3444461: navigations 'expand sidebar' (title) lacks connection to flow
- #3531948: Top-level menu items in the footer region are too far away from their submenu items
Needs triage
- #3573225: Some top-level menus obscure unrelated focused items in sidebar
- #3574319: Sidebar logo link sometimes lacks focus indicator
- #3540337: Improve visibility of More actions menu button
- #3576830: Grandchild menu items lack focus indicator
Done
- #3439643: Improve how and what navigation block titles are communicating to screenreader users
- #3570505: Navigation's top level menu items for workspaces and help have the same ID when caching enabled
- #3443571: Mobile version of Navigation should have focus trap (needs feedback from screenreader users)
- #3572169: Put the mobile sidebar close button into the TAB sequence
- #3441586: Navigation logo link does not communicate where it is taking the user
- #3438477: High contrast mode needs some more refinement
- #3541910: Elements in closed sidebar are focusable
- #3542774: The “reduce motion” setting in the operating system should be respected
- #3452724: Navigation side bar and top bar should have appropriate aria labels
- #3436130: Ensure keyboard navigation works with the drawer
- #3498326: Focus outline has a too low color contrast and uses a different green than Claro
- #3506743: Increase the color contrast of the navigation block title
- #3393398: Avoid duplicated IDs on the sidebar
- #3395240: [aria-*] attributes are not valid or misspelled
- #3395584: Close button’s SVG icon image is missing required label and attribute
- #3395240: [aria-*] attributes are not valid or misspelled
- #3395608: Sidebar navigation headings are not in a logical order (H2, H3, H3, H3)
- #3395559: Prevent a selected menu item from jumping out of the viewport
- #3403423: Provide more helpful region labels
- #3423277: Icons are invisible in high contrast mode
- #3426627: Enable keyboard users to expand and collapse submenus also when the navigation is collapsed
- #3551528: Mobile expanded sidebar modal overlay has invalid ARIA attribute: aria-expanded
- #3572628: Mobile sidebar should close by ESCAPE key
- #3541741: [PP-1] Close only lowest-level submenu with Escape key
Related issues and discussions
| Comment | File | Size | Author |
|---|---|---|---|
| #14 | Screenshot from 2023-10-18 14-10-41.png | 52.32 KB | kostyashupenko |
Issue fork navigation-3391723
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
- 3391723-pp1plan-accessibility-review
changes, plain diff MR !79
Comments
Comment #4
finnsky commentedWe have automated Nightwatch a11y tests in core:
https://www.drupal.org/project/drupal/issues/3293469
Added simple tests using it. For now 2 failures related to current 1.x Navigation:
For tests:
1. Setup NightWatch as described:
https://git.drupalcode.org/project/drupal/-/blob/11.x/core/tests/README....
2. Clone Navigation module to /modules dir.
3. Run: yarn test:nightwatch --tag navigation
Comment #5
finnsky commentedLater we need to add tests for:
- Tab navigation
- Collapsed state Tooltips/Menus
etc.
Comment #6
ckrinaHi @finnsky! Sorry If I wasn't clear the other day: this issue is not supposed to have any MR, just links to other issues with their own MR. Could you open 1 or 2 child issues yourself and add the MR in there?
Comment #7
finnsky commentedYep, This is only approach MR. I think it is cool to have nightwatch testing. Not even only for A11y
Comment #8
ckrinaUn-postponing this after first iteration of mobile has made it so the plan definition can start from something more realistic..
Comment #9
ckrinaComment #10
ckrinaComment #11
ckrinaAdding #3393398: Avoid duplicated IDs on the sidebar, also credited @finnsky in there for finding it.
Comment #12
ckrina@finnsky I've added #3393400: Implement Nightwatch tests for Navigation module to move the discussion into its own issue. Could you add any missing information you think could help and move the MR to there?
Comment #13
andypostIs there any way to add searching within menu tree?
There's old core issue about it #102254: Add an administrative search feature
Comment #14
kostyashupenkoI'm adding my feedback from slack to hear opinions

Comment #15
ckrinaThanks @kostyashupenko, copying the answer from Slack so anybody landing here have context :)
tldr: in the first round of Usability tests we found that using a split button (initial approach, link+button) was confusing for users. Even with the initial designs showing that there were 2 things (link + submenu toggle), so we changed to the current approach for the second test with the University of Minnesota UX experts (with experienced Drupal users too). This approach proved to be the most usable, plus it’s a standard pattern (so what users expect).
The missing thing to solve is how to get to the parent pages. We have several solutions in mind (like adding that link on the submenu itself), but the main question is: are those admin list pages really necessary? The only extra thing they give is a description. If you can get to the links through the menu itself, the only page that could be argued that the only pages that really gives something is the Configuration page. We haven’t get to a perfect solution yet, so any idea is welcome.
But using a split button have proven to not be the most usable solution, so if we really want those pages (which don’t add any value apart from listing child items that you can see on the menu already) we need to find another way to do so :)
Comment #16
ckrinaComment #17
ckrinaComment #18
ckrinaSorry @andypost I totally missed your question before. We're not thinking about integrating it in the initial MVP/alpha, but we're planning on working with the Admin Toolbar maintainers to be sure their features integrate with this new toolbar and they have a solution for it.
Either way, we have designs for a search box and it would be great to have such a feature at some point integrated. Let's see where we can get :)
Comment #19
ckrinaComment #20
ckrinaAdding more issues.
Comment #21
ckrinaAdding related issue.
Comment #22
ckrinaAdding #3403423: Provide more helpful region labels as a child issue.
Comment #23
rkollerI've created an issue (#3424484: Improve the color contrast for structural interface components) about the color contrast for structural interface components for Claro in general, but one of the examples (example C) covers the navigation module in particular. This kind of problem isn't covered by any WCAG success criterion at this point. Therefore I don't wanted to directly add the issue to the issue summary or link it as a child issue. Therefore I've decided to just leave a comment.
On the other hand I'll add #3423277: Icons are invisible in high contrast mode to the issue summary. I've already added it as a child issue a few days ago but forgot to comment in here and add it to the issue summary.
Comment #24
ckrinaComment #25
rkollerCreated another issue in the context of keyboard interaction: #3426627: Enable keyboard users to expand and collapse submenus also when the navigation is collapsed
Comment #26
mgiffordI would like to have some nightwatch-axe Core tests set up to test the new navigation. I think that the dynamic functionality that we're going to want to be able to deliver should come with some dynamic automated tests.
Comment #27
ckrinaIdeas on things that could be tested on the front-end (it'd miss tests for the admin pages):
And ideas for series of types of test:
prefers-reduced-motionmedia query for the animationsComment #28
ckrinaAttempt to follow @rkoller's suggestion on Slack and update the issue summary more as a plan with a protocol to follow. Probably a doc will need to be create a more completed protocol to follow.
Comment #29
ckrinaComment #30
ckrinaComment #31
ckrinaComment #32
rkollerComment #33
ckrinaAdding link to an environment to test.
Comment #34
charles belovThe Tugboat environment in the current issue description is no longer available as of 4:49 pm PDT (+7) April 8, 2024.
Comment #35
ckrinaUpdated Tugboat link with a more reliable one: https://accessibility-tests-ibvgtgmk3akstqwvcqkak0ytg1ex70ce.tugboatqa.com/ and a few additions to the protocol.
Comment #36
rkollerComment #37
katannshaw commentedComment #38
rkollerComment #39
katannshaw commentedComment #40
katannshaw commentedComment #41
rkollerFor the records, @charles-belov (Thanks to him for taking the time) tested the navigation module to validate if there are any concerns with animations in the context of vestibular disorder. His conclusion was:
I'm not seeing any animation concerns in either mobile or desktop..
Comment #42
katannshaw commentedAdded link to Google sheet with WCAG 2.2 success criteria for reporting issues.
Comment #43
charles belovI believe that the menu navigation as described in #3436130: Ensure keyboard navigation works with the drawer is not behaving as described. The issue is marked as fixed. Would you prefer that I open a new issue or reopen #3436130: Ensure keyboard navigation works with the drawer?
Specifically, I can only navigate through the menu using tab and enter keys; the arrow keys don't accomplish anything. I actually prefer that. However, concerningly, escape does not work to exit sub-menus and I have to tab out of them. (I'm not filing this here in the current issue - I just wanted it here so that when you respond I can simply follow the desired instructions and not have to hunt this down somewhere else.)
Please advise.
Comment #44
ckrina@Charles Belov opening a new issue referencing the any previous work and whatever references needed is the ideal workflow.
Comment #45
charles belovThank you @ckrina. Before I file, I just noticed that #3436130: Ensure keyboard navigation works with the drawer was only committed 6 days ago. Has it been merged into the Tugboat test instance?
I went to the available updates list for the Tugboat test instance to try to determine this, but the Navigation module is not listed on that page. (Is this also a bug?)
If it hasn't been merged to the instance yet, that would certainly explain why I'm not seeing the changes there.
Comment #46
finnsky commented@Charles Belov
You are right. Seems this tugboat instance is outdated.
Comment #47
mherchelAdding #3443571: Mobile version of Navigation should have focus trap
Comment #48
ckrinaComment #49
ckrinaUpdating test environment link with the latest changes now that Navigation is in core.
Comment #50
mherchelUpdating title.
Comment #51
skaughtComment #53
mglamanOpened #3446357: Fix overflow visibility for wrapper content in navigation CSS. Buttons are not accessible inside of
display: contents;Comment #54
rkolleradded #3498326: Focus outline has a too low color contrast and uses a different green than Claro
Comment #55
ckrinaMaking sure #3421969: [PLAN] New Navigation and Top Bar to replace Toolbar Roadmap: Path to Stable is set as the parent issue.
Comment #56
rkolleradded #3504913: Navigation block titles have a too low color contrast
Comment #57
rkollerreplaced the link to #3504913: Navigation block titles have a too low color contrast, since it got closed by #3506743: Increase the color contrast of the navigation block title
Comment #58
rkollerI've created #3531948: Top-level menu items in the footer region are too far away from their submenu items and added it to "other" for now - none of the other categories is a good fit for it. and i've also added #3452724: Navigation side bar and top bar should have appropriate aria labels
Comment #59
kentr commentedAdded #3541688: Focus does not move to submenu when opened by enter or space key.
Comment #60
kentr commentedAdded #3541728: Submenu opened with hover does not close by Escape key when another menu item has focus.
Comment #61
kentr commentedAdded #3541741: [PP-1] Close only lowest-level submenu with Escape key.
Comment #62
kentr commentedAdded #3541910: Elements in closed sidebar are focusable.
Comment #63
mgiffordThe Gin integration I think are going to effect this.
Comment #64
rkolleradded #3542774: The “reduce motion” setting in the operating system should be respected to the animation section in the issue summary
Comment #65
rkolleradded #3543541: [PP-1] on the mobile viewport with the navigation sidebar collapsed the menu items are still available in the aural interface to the screen readers section
Comment #66
kentr commentedAdded #3551528: Mobile expanded sidebar modal overlay has invalid ARIA attribute: aria-expanded
Comment #67
xjmJust moving some completed issues to the "Done" section of the IS. (Meanwhile, several open issues have been promoted to higher issue priority internally.)
Comment #68
xjmEdited my above comment to mention that we also bumped the priority of the open issues based on our best understanding of our severity. I should have also promoted this meta itself at the time, so doing that now.
It's also always helpful to have accessibility maintainers or experts in the field give feedback on the relative severity of the individual issues, and of course we could use help fixing them in the best way possible as well. Most accessibility bugs are eligible for backport even in patch releases, because the disruption to sites is outweighed by the value of resolving the accessibility bug. Resolving the more serious accessibility issues is our top priority for Navigation going forward.
Comment #69
catchComment #70
catchComment #72
catch#3541910: Elements in closed sidebar are focusable just landed. This also fixed #3543541: [PP-1] on the mobile viewport with the navigation sidebar collapsed the menu items are still available in the aural interface which turned out to be a duplicate or at least the same fix.
In terms of inclusion in Standard, I don't think #3443571: Mobile version of Navigation should have focus trap and one or two similar issues should block - they are specifically around keyboard navigation on mobile. Keyboard navigation on desktop is obviously very common, hidden items leaking into the aural interface would interfere even with normal site usage on mobile for people with access to navigation. But actually using the navigation bar with keyboard on mobile should not be happening nearly as often. Obviously we should fix the bugs, just doesn't seem at the same level compared to other issues in the list.
#3438477: High contrast mode needs some more refinement is RTBC so hopefully that can land soon.
Comment #73
catchComment #74
kentr commented@catch
To me, the "mobile" version of the menu is a misnomer here. It's really about narrow viewports.
For example, I frequently work with side-by-side windows on my laptop, and in this case that gives me the "mobile" version of the sidebar. I wonder if someone might also experience it if they're using a tablet as a second monitor.
I'm not necessarily saying that should make it a blocker. Just wanted to mention it for consideration.
Comment #75
kentr commentedThe "mobile" sidebar also kicks in on the laptop with a full-screen window zoomed up a few notches.
Comment #76
rkolleradded an issue about duplicate IDs to the other section
Comment #77
rkollerrevisiting #3439721: Make the link descriptions more descriptive, helpful, and clear. i'Ve noticed that #3441586: Navigation logo link does not communicate where it is taking the user that was mentioned there wasn't added to this meta yet.
Comment #78
rkollerI've updated the list of the remaining issues in the issue summary. Based on the discussion with @katannshaw, @mgifford, @mherchel, and myself the remaining issues got categorized into blockers for the navigation module going into the standard profile and none blockers. In today's call we only had time discussing the issues currently listed in this meta. We will have another call or discussion on slack about a few additional issues not list in here that at the very least have accessibility aspects.
Comment #79
rkolleradded the two follow ups to the focus trap issue also to the list of blockers #3572628: Mobile sidebar should close by ESCAPE key and #3572169: Put the mobile sidebar close button into the TAB sequence.
Comment #80
rkollerComment #81
rkolleranother correction for the list #3439721: Make the link descriptions more descriptive, helpful, and clear. was added to both lists by accident. now everything should be correctly categorized
Comment #82
mherchelSaving to re-update statuses
Comment #83
rkollerby the way the (needs feedback from screenreader userss) note in the issue summary for the focus strap issue could be striked now i suppose with the feedback by at least james scholes on the a11y slack? not sure who else is a screenreader user from the people answering there, i only know from james.
Comment #84
mherchelAlright. I think we got all stable profile blockers set to RTBC or Needs Review.
Please review em!
Comment #85
kentr commentedAdded #3573225: Some top-level menus obscure unrelated focused items in sidebar as a child, but not into the IS b/c it needs triage.
It's similar to #3443571: Mobile version of Navigation should have focus trap in that it's possible to tab into hidden items, and might be a blocker for the same reasons.
Comment #86
kentr commentedAdded #3574319: Sidebar logo link sometimes lacks focus indicator, and a Needs Triage section to the IS for new issues.
Comment #87
kentr commentedComment #88
catchComment #89
catchComment #90
kentr commentedMoved #3540337: Improve visibility of More actions menu button to here from #3421969: [PLAN] New Navigation and Top Bar to replace Toolbar Roadmap: Path to Stable.
Comment #91
catchComment #92
kentr commentedMoved some items to Done and restructured the triage categories.
Comment #93
kentr commentedNoted in IS that #3541728: Submenu opened with hover does not close by Escape key when another menu item has focus is currently Major priority.
Moved #3541741: [PP-1] Close only lowest-level submenu with Escape key to Done
Comment #94
kentr commentedComment #95
kentr commentedAdded #3576830: Grandchild menu items lack focus indicator