Skip to content

docs: clarify aside complementary role mapping #44629

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.

Sign up for GitHub

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

Open
ishaanlabs-gg wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −3
Open

docs: clarify aside complementary role mapping #44629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions files/en-us/web/accessibility/aria/reference/roles/complementary_role/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is a sidebar containing links to project sponsors.
The `complementary` role is [a landmark](/en-US/docs/Web/Accessibility/ARIA/Guides/Techniques#landmark_roles) role. Landmarks can be used by assistive technology to quickly identify and navigate to large sections of the document. Content listed within a container with the `complementary` landmark role should make sense if separated from the main content of the document.

> [!NOTE]
> Using the {{HTMLElement('aside')}} element will automatically communicate a section has a role of `complementary`. Developers should always prefer using the correct semantic HTML element over using ARIA.
> Using the {{HTMLElement('aside')}} element will usually communicate a section has a role of `complementary`. When an `<aside>` is nested in sectioning content, it maps to `complementary` only if it has an accessible name. Developers should always prefer using the correct semantic HTML element over using ARIA.

## Examples

Expand Down Expand Up @@ -54,7 +54,7 @@ The `complementary` role is [a landmark](/en-US/docs/Web/Accessibility/ARIA/Guid

### Prefer HTML

Using the {{HTMLElement('aside')}} element will automatically communicate that the element has a role of `complementary`. If possible, prefer using the semantic `<aside>` element instead of the `complementary` role.
Using the {{HTMLElement('aside')}} element will usually communicate that the element has a role of `complementary`. If an `<aside>` is nested in sectioning content, it maps to `complementary` only if it has an accessible name. If possible, prefer using the semantic `<aside>` element instead of the `complementary` role.

### Labeling landmarks

Expand Down
3 changes: 2 additions & 1 deletion files/en-us/web/html/reference/elements/aside/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ This element only includes the [global attributes](/en-US/docs/Web/HTML/Referenc
## Usage notes

- Do not use the `<aside>` element to tag parenthesized text, as this kind of text is considered part of the main flow.
- The implicit ARIA role of `<aside>` is `complementary` when it is scoped to the {{HTMLElement("body")}} or {{HTMLElement("main")}} element. If it is nested in sectioning content, such as an {{HTMLElement("article")}}, {{HTMLElement("section")}}, or another `<aside>`, it maps to the `complementary` role only if it has an accessible name. Otherwise, it maps to the `generic` role.

## Examples

Expand Down Expand Up @@ -128,7 +129,7 @@ This example uses `<aside>` to mark up a paragraph in an article. The paragraph
><a href="/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/complementary_role"
>complementary</a
></code
>
>, or <code>generic</code> when nested in sectioning content without an accessible name
</td>
</tr>
<tr>
Expand Down