-
-
Notifications
You must be signed in to change notification settings - Fork 557
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
How to: Article how to make an accessible nav with dropdowns #1472
base: main
Are you sure you want to change the base?
Changes from 7 commits
a2e1faf
42ae52d
2fc387f
bf169ff
4be5041
6e27a42
2c7f44c
ee903f8
5ccade9
aced8ff
3b94ee3
404459b
f2314eb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,233 @@ | ||||||||||
--- | ||||||||||
title: Make an accessible <nav> with dropdowns | ||||||||||
description: Navigation is a critical part of any application, it allows people to complete journeys and find the information they need. So making it accessible is key. | ||||||||||
category: How-to | ||||||||||
author: James Bateson | ||||||||||
date: 2022-09-04 | ||||||||||
further_reading: | ||||||||||
- title: "Menus & Menu Buttons" | ||||||||||
url: https://inclusive-components.design/menus-menu-buttons/ | ||||||||||
source: Heydon Pickering | ||||||||||
- title: "Don't use ARIA menu roles for site nav" | ||||||||||
url: https://adrianroselli.com/2017/10/dont-use-aria-menu-roles-for-site-nav.html | ||||||||||
source: Adrian Roselli | ||||||||||
- title: "Navigation role support" | ||||||||||
url: https://a11ysupport.io/tech/aria/navigation_role | ||||||||||
source: Accessibility Support | ||||||||||
- title: "Top 5 rules of ARIA" | ||||||||||
url: https://www.deque.com/blog/top-5-rules-of-aria/ | ||||||||||
source: Deque | ||||||||||
- title: "Are your anchor links accessible?" | ||||||||||
url: https://amberwilson.co.uk/blog/are-your-anchor-links-accessible/ | ||||||||||
source: Amber Wilson | ||||||||||
- title: "Local Navigation Is a Valuable Orientation and Wayfinding Aid" | ||||||||||
url: https://www.nngroup.com/articles/local-navigation/ | ||||||||||
source: Nielsen Norman Group | ||||||||||
- title: "Cognitive accessibility" | ||||||||||
url: https://developer.mozilla.org/en-US/docs/Web/Accessibility/Cognitive_accessibility | ||||||||||
source: MDN Web Docs | ||||||||||
thanks: "Anya Mueller, Alex Hall" | ||||||||||
tags: | ||||||||||
- howto | ||||||||||
--- | ||||||||||
|
||||||||||
Navigation is a critical part of any application and can often involve many levels of nesting. It allows people to complete journeys and find the information they need. So making it accessible is key. HTML5 includes the <nav> section element to help with this. | ||||||||||
scottaohara marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
|
||||||||||
## The nav section element | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The issue I came across with trying to wrap this one in anything that represented code, was that when it parses this to turn it into a heading in the table of contents, I think it's trying to render a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oof, yeah. Let's ignore wrapping code in the headings for now, and I'll get to the bottom of this bug. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I probably should have opened one when I spotted it writing this sorry, but wasn't sure if it was intended. Anyway, sounds good, thank you :) |
||||||||||
|
||||||||||
Let's start with a quick overview of <nav>. The <nav> section element has semantic meaning and comes with accessibility benefits by using it to mark-up sections of navigation. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
<blockquote> | ||||||||||
<p>The <nav> HTML element represents a section of a page whose purpose is to provide navigation links, either within the current document or to other documents. Common examples of navigation sections are menus, tables of contents, and indexes.</p> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
<footer> | ||||||||||
<cite><a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/nav">MDN web docs: <nav>: The Navigation Section element</a></cite> | ||||||||||
</footer> | ||||||||||
</blockquote> | ||||||||||
|
||||||||||
Here's the example markup that we'll build up throughout this article. It's worth noting this is an example of accessible navigation. | ||||||||||
|
||||||||||
```html | ||||||||||
<nav> | ||||||||||
<ul> | ||||||||||
<li><a href="#">Home</a></li> | ||||||||||
<li><a href="#">About</a></li> | ||||||||||
<li><a href="#">Work</a></li> | ||||||||||
<li><a href="#">Contact</a></li> | ||||||||||
</ul> | ||||||||||
</nav> | ||||||||||
``` | ||||||||||
|
||||||||||
### Semantics | ||||||||||
|
||||||||||
The <nav> element will communicate a role of navigation-equal to setting `role="navigation"`, (this may still need to be added if needing to [support some assistive technology](https://a11ysupport.io/tech/aria/navigation_role)) meaning it can be easily navigated to by people with screen readers—as a landmark. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Suggesting breaking this apart to communicate:
|
||||||||||
|
||||||||||
### Best practices summarized | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
We haven't discussed these overtly in the preceding sections, so removing "summarized", as this is their first appearance. |
||||||||||
|
||||||||||
- Not all blocks containing links need to use <nav>. Use it for larger sections of navigation links. Overuse can create 'noise' for people using screen readers. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Nice! |
||||||||||
- Uniquely label the <nav> to give a better idea of its purpose. This can be done with a heading or `aria-label`/`aria-labelledby`. **Note**: Screen readers will already announce the element as being navigation, so avoid using the word 'nav' or 'navigation' in the accessible name. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I love this, but it comes as sort of a surprise and does not offer specific code examples. I worry people won't know of a good pattern to reference, and might not develop it properly. Can we introduce the concept earlier in the post? |
||||||||||
- For site navigation consider using a list (`<ul>/<ol>`) inside of the <nav>. So that assistive technology can announce how many links it contains. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
```html | ||||||||||
<nav aria-labelledby="main-nav-label"> | ||||||||||
<h2 id="main-nav-label" class="visually-hidden">Main menu</h2> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
"Menu" has a very specific meaning in the context of authoring accessible components. I'd advocate for removing it. |
||||||||||
|
||||||||||
<ul> | ||||||||||
... | ||||||||||
</ul> | ||||||||||
</nav> | ||||||||||
|
||||||||||
<nav aria-label="Main menu"> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
<ul> | ||||||||||
... | ||||||||||
</ul> | ||||||||||
</nav> | ||||||||||
``` | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. GitHub can't easily handle this via suggestion, but can we:
|
||||||||||
|
||||||||||
## Adding dropdowns | ||||||||||
|
||||||||||
Navigation designs often need many levels of links underneath a top-level link. This results in using the dropdown pattern, whereby a hidden set of links are shown by interacting with the parent, this can be many levels deep. Some accessibility considerations must be made before implementation. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Clarifying that the design is the result of the site or app's information architecture, as well as dropdown nav applies to both 1 and 1+ nested levels of navigation hierarchy. |
||||||||||
|
||||||||||
- How would the navigation show if there were no styles? | ||||||||||
- How should the parent link toggle the dropdown? | ||||||||||
- How can focus order be handled correctly? | ||||||||||
- Does the parent link still need to keep its link functionality? | ||||||||||
- Make sure that dropdowns are hidden from assistive technology until needed. | ||||||||||
|
||||||||||
Dropdown sub-navigation is typically marked up as a nested list inside of the parent link list item. | ||||||||||
|
||||||||||
```html | ||||||||||
<nav aria-label="Main menu"> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
<ul> | ||||||||||
<li><a href="#">Home</a></li> | ||||||||||
<li> | ||||||||||
<a href="#">About</a> | ||||||||||
<ul> | ||||||||||
<li><a href="#">Our history</a></li> | ||||||||||
<li><a href="#">Meet the team</a></li> | ||||||||||
</ul> | ||||||||||
</li> | ||||||||||
<li><a href="#">Work</a></li> | ||||||||||
<li><a href="#">Contact</a></li> | ||||||||||
</ul> | ||||||||||
</nav> | ||||||||||
``` | ||||||||||
|
||||||||||
### Tip 1: No styles | ||||||||||
|
||||||||||
Structuring the markup as shown in the previous example means without any CSS loaded, the links would show as a default nested list and items underneath the parent link, clear both visually and semantically. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💯 |
||||||||||
|
||||||||||
### Tip 2: Parent link toggle | ||||||||||
|
||||||||||
Navigation patterns will often attach a click/focus event to the entire parent link to reveal the dropdown of nested items. This comes with two problems. Using a click means extra functionality is needed to handle the primary purpose of the parent link, which should itself act as a link. By using focus, people traversing the navigation using a keyboard would be required to tab through all dropdowns regardless of whether they wanted to or not. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm a little unclear what the difference between issue one and issue two are. Could we break them out into an ordered list? |
||||||||||
|
||||||||||
Adding a toggle element, for example, an arrow icon button, within the parent link allows people to only show the dropdown if they are interested in seeing further links associated with the parent. Make sure that the toggle element has enough of a tap/click (this pattern could be used for mobile as well) area and accessible focus/hover states. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could we link to an example of what a toggle element is? This is the first time we've mentioned it, but it is vital for constructing accessible tiered nav. |
||||||||||
|
||||||||||
**Note:** If your parent elements don't need to be a link themselves, make sure to use a `<button>` element, so that they can communicate they are expandable and have an event associated and benefit from all the accessible goodness buttons get for free. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Adding |
||||||||||
|
||||||||||
```html | ||||||||||
<nav aria-label="Main menu"> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
<ul> | ||||||||||
<li><a href="#">Home</a></li> | ||||||||||
<li> | ||||||||||
<a href="#"> | ||||||||||
About Us | ||||||||||
<button> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
<svg aria-hidden="true">...</svg> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Added |
||||||||||
<span class="visually-hidden">Toggle About Us submenu</span> | ||||||||||
</button> | ||||||||||
</a> | ||||||||||
<ul> | ||||||||||
<li><a href="#">Our history</a></li> | ||||||||||
<li><a href="#">Meet the team</a></li> | ||||||||||
</ul> | ||||||||||
</li> | ||||||||||
<li><a href="#">Work</a></li> | ||||||||||
<li><a href="#">Contact</a></li> | ||||||||||
</ul> | ||||||||||
</nav> | ||||||||||
``` | ||||||||||
|
||||||||||
### Tip 3: Focus order | ||||||||||
|
||||||||||
By nesting the dropdown list as a direct child of the parent list item, it means that when visible, the first link will be the next focusable element after the parent item toggle. So adding a trigger inside the parent link is a great way to ensure a person intends to see the dropdown for that link and so take focus to the first link in said dropdown. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Can we break this into two sentences to help lower the reading level? |
||||||||||
|
||||||||||
Related to focus, another nice feature would be to make sure that if the person pressed the <kbd>ESC</kbd> key, the dropdown would close, and the person's focus return to the toggle element they used to open it. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
### Tip 4: Parent link functionality | ||||||||||
|
||||||||||
A parent link for a dropdown generally will still need to keep its functionality as a link. This can present problems if, for example, a click event has been attached to it to reveal a dropdown. Giving people an explicit way to toggle the visibility of dropdowns is a much nicer option. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
### Tip 5: Showing/hiding the dropdown | ||||||||||
|
||||||||||
When the navigation dropdown is closed, it's important to ensure the nested links are not visible to assistive technology. For example, people using a keyboard cannot tab to the links—this can lead to confusion on where their focus is on the page. | ||||||||||
|
||||||||||
To hide elements such as sub-menus from assistive technology, you should not rely on `opacity`. Although visually hidden, it would still allow the dropdown to be discoverable via assistive technology. To ensure that dropdowns are hidden until people choose to access that sub-navigation, consider toggling the `display: none;` or `visibility: hidden;` properties. | ||||||||||
jimbateson marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
|
||||||||||
## What about ARIA? | ||||||||||
|
||||||||||
<blockquote> | ||||||||||
<p>Before you use ARIA, use native HTML elements or attributes first. In the case that the semantics you are looking for is not available in HTML, then use ARIA.</p> | ||||||||||
<footer> | ||||||||||
<cite><a href="https://www.deque.com/blog/top-5-rules-of-aria/">Deque: Top 5 rules of ARIA</a></cite> | ||||||||||
</footer> | ||||||||||
</blockquote> | ||||||||||
|
||||||||||
When thinking about making some component interactions accessible, it's often assumed that more complex ARIA attributes and patterns may be needed. But a <nav> with dropdowns does not need any. There are [menu-related ARIA patterns available](https://www.w3.org/TR/wai-aria-practices/#menu). But these are slightly different in context from the site navigation pattern in this article. Menu ARIA is more designed to deal with native operating system-like menus, for example, a selection of options for a person. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Two thoughts, so two paragraphs. Also emphasizing not needing menu roles. I also removed the example, as I don't want to suggest that's the only relevant menu to consider. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Makes sense, will keep the related further reading link in as as well so people can further explore this if they wish and look for examples :) |
||||||||||
|
||||||||||
Although <nav> can be used without ARIA to create accessible navigation, there are things we can do with it to provide a better experience for people. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
### Expanded states (aria-expanded) | ||||||||||
|
||||||||||
The `aria-expanded` attribute can be used to communicate whether a toggle control is expanded or collapsed. In our navigation example, this could be useful to inform people using screen readers if the dropdown is open or not, based on whether the toggle is expanded or collapsed. This value of the attribute would need to be changed via JavaScript when the person opened and closed the dropdown. | ||||||||||
|
||||||||||
```html | ||||||||||
<nav aria-label="Main menu"> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
<ul> | ||||||||||
<li><a href="#">Home</a></li> | ||||||||||
<li> | ||||||||||
<a href="#"> | ||||||||||
About Us | ||||||||||
<button aria-expanded="false"> | ||||||||||
<svg aria-hidden="true">...</svg> | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
<span class="visually-hidden">Toggle About Us submenu</span> | ||||||||||
</button> | ||||||||||
</a> | ||||||||||
<ul> | ||||||||||
<li><a href="#">Our history</a></li> | ||||||||||
<li><a href="#">Meet the team</a></li> | ||||||||||
</ul> | ||||||||||
</li> | ||||||||||
<li><a href="#">Work</a></li> | ||||||||||
<li><a href="#">Contact</a></li> | ||||||||||
</ul> | ||||||||||
</nav> | ||||||||||
``` | ||||||||||
|
||||||||||
### Current link (aria-current) | ||||||||||
|
||||||||||
A common navigation design will see the currently active page link visually different in some way, indicating to the person which page they are on. But this isn't helpful for people who may not be able to see this distinction. The `aria-current` attribute can be used to inform assistive technology that a link is the current page. `aria-current` accepts a set list of values, the most suitable for the main navigation item would be `aria-current='page'`. | ||||||||||
jimbateson marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
|
||||||||||
## Skip links | ||||||||||
|
||||||||||
Although not technically required to make accessible navigation, making sure your site has a 'skip link' (usually visually hidden until tabbed to) that can bypass the main site navigation is a handy usability feature. It allows someone to jump directly to a page's <main> landmark, skipping common and repeated site areas, such as the navigation so the person does not need to traverse this content on every page. | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
## Alternatives | ||||||||||
|
||||||||||
Multi-level navigation with dropdowns often referred to as 'mega menus' can often be complex and need some thought to navigate. In certain cases, we might want to consider an alternative. | ||||||||||
scottaohara marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I really appreciate that you're providing segue paragraphs after your section headings 🙂 |
||||||||||
|
||||||||||
### In-page navigation/table of contents | ||||||||||
|
||||||||||
One option could be to keep the top-level navigation as links only. Then, on their child pages, have an in-page navigation/table of contents. If the content length was suitable and the page didn't need to be broken out into further pages, these links would then anchor down the page to the relevant sections. | ||||||||||
|
||||||||||
**Note**: There are [accessibility considerations to be aware of](https://amberwilson.co.uk/blog/are-your-anchor-links-accessible/) when using this pattern. | ||||||||||
|
||||||||||
### Local navigation | ||||||||||
|
||||||||||
Local navigation can help people understand where they are, and what content might be related to the page they are on. This could look similar to the page of contents previously mentioned, but instead of the links anchoring, each would go to a separate page. Or it could sit below the main navigation, for example, but being individual to a page. | ||||||||||
|
||||||||||
<blockquote> | ||||||||||
<p>Visible local navigation is usually beneficial when users engage in exploratory browsing, rather than known-item search. In such situations, users may visit several pages within a category — either because they do not know exactly what category they need, even though they have a sense of its neighborhood, or because they need to combine or compare information from multiple categories</p> | ||||||||||
<cite><a href="https://www.nngroup.com/articles/local-navigation/">Nielsen Norman Group: Local Navigation Is a Valuable Orientation and Wayfinding Aid</a></cite> | ||||||||||
</blockquote> | ||||||||||
|
||||||||||
**Note**: Be wary of changing how navigation appears and functions across multiple pages, predictability can be an important part of [cognitive accessibility](https://developer.mozilla.org/en-US/docs/Web/Accessibility/Cognitive_accessibility). | ||||||||||
jimbateson marked this conversation as resolved.
Show resolved
Hide resolved
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggesting two things here:
code
element, which I will be doing for other instances.