A11Y 101: Ensure landmarks are unique

While analyzing my website, we found the following error: "Ensure landmarks are unique".

This specific error occurred on a post detail page with two <nav> elements.

One is used for the tags, and one is in the footer.

Why does it matter?

You might be wondering why these landmarks should be unique? And that's a very valid question.

Let's view this scenario from a screen reader perspective.

Screen readers use landmarks to identify the structure on a page. If two or more of the same landmark are present, we need to make them unique with labels.

The screen reader can identify what each landmark is used for. This is especially important for navigation elements.

Fixing the issue

Let's take my website as an example and fix the issue. There are two nav elements, and we need to identify them.

I added the aria-label as "Tag" for the tag element.

<nav aria-label="Tag">
  <ul>
    <li>#remix</li>
  </ul>
</nav>

Do note that you don't have to explicitly state navigation. As the screen readers will already read this as "tag navigation".

And for the footer we apply the same concept:

<nav aria-label="Footer">
  <ul>
    <li>about</li>
  </ul>
</nav>

And that's it. By defining the aria label, we ensure each landmark is unique.

This concept should also be applied to duplicate headers, footers, and forms as they are all landmarks.

Repeated landmarks

I hear you wonder, but what about repeated landmarks? So, for instance, are your navigation in the header and footer precisely the same?

Well, you can use the same label in that case.

<header>
  <nav aria-label="Main">
    <ul>
      <li>home</li>
    </ul>
  </nav>
</header>

<footer>
  <nav aria-label="Main">
    <ul>
      <li>about</li>
    </ul>
  </nav>
</footer>

Thank you for reading, and let's connect!

Thank you for reading my blog. Feel free to subscribe to my email newsletter and connect on Facebook or Twitter

A11Y 101: Ensure landmarks are unique

Comments

A11Y 101

A11Y 101: Missing form labels

More from this blog

I wrote 1000 articles, what’s next?

Vendure community and more

Deploying Vendure

Vendure - Overwriting email templates

Customizing vendure

Why does it matter?

Fixing the issue

Repeated landmarks

Thank you for reading, and let's connect!

Command Palette

Comments

A11Y 101

A11Y 101: Missing form labels

More from this blog

Why does it matter?

Fixing the issue

Repeated landmarks

Thank you for reading, and let's connect!