accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
104 lines (88 loc) • 4.54 kB
HTML
<html lang="en-US">
<head>
<title>aria_complementary_label_unique - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"pass":"The element with \"complementary\" role has a unique label that describes its purpose","fail_label_not_unique":"Multiple elements with \"complementary\" role do not have unique labels","group":"Each element with \"complementary\" role must have a unique label that describes its purpose"}};
RULE_ID = "aria_complementary_label_unique"
</script>
<!--
/******************************************************************************
Copyright:: 2022- IBM, Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*****************************************************************************/
-->
<!-- Title and messages generated at build time -->
<link rel="icon" href="https://ibm.com/able/favicon-32x32.png" type="image/png">
<link rel="icon" href="https://ibm.com/able/favicon.svg" type="image/svg+xml">
<link rel="stylesheet" href="../common/help.css" />
<script type="module">
import "https://1.www.s81c.com/common/carbon/web-components/version/v1.35.0/code-snippet.min.js";
import "https://1.www.s81c.com/common/carbon/web-components/version/v1.35.0/list.min.js";
</script>
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script src="../common/help.js"></script>
</head>
<body>
<div class="bx--grid toolHelp">
<div class="bx--row">
<div class="bx--col-sm-4 bx--col-md-8 bx--col-lg-16 toolHead">
<!-- Group message injected here -->
<h3 id="ruleMessage"></h3>
<!-- Severity level injected here -->
<div id="locLevel"></div>
<!-- Rule specific message injected here -->
<p id="groupLabel"></p>
</div>
</div>
<div class="bx--row">
<div class="bx--col-sm-4 bx--col-md-5 bx--col-lg-8 toolMain">
<!-- Start main panel -->
<mark-down><script type="text/plain">
### Why is this important?
When there are multiple elements with a `"complementary"` role, they must have unique labels that clearly describe the region's content. This includes `<aside>` elements, which have the implicit role of `"complementary"`. These labels help people using assistive technologies to quickly find and navigate to each region.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* For each element with a `"complementary"` role, either set the value of the `aria-labelledby` attribute to the `id` value of any visible text that appropriately and uniquely describes that region's content
* **Or**, use the `aria-label` attribute to add an invisible, unique, non-empty label to each element with the `"complementary"` role
For example:
```
<h2 id="weather">Weather portlet</h2>
<div role="complementary" aria-labelledby="weather">
...
</div>
<div role="complementary" aria-label="Stock ticker portlet">
...
</div>
```
</script></mark-down>
<!-- End main panel -->
<!-- This is where the rule id is injected -->
<div id="ruleInfo"></div>
</div>
<div class="bx--col-sm-4 bx--col-md-3 bx--col-lg-4 toolSide">
<!-- Start side panel -->
<mark-down><script type="text/plain">
### About this requirement
* [IBM 2.4.1 Bypass Blocks](https://www.ibm.com/able/requirements/requirements/#2_4_1)
* [ARIA6: aria-label to label objects](https://www.w3.org/WAI/WCAG22/Techniques/aria/ARIA6)
* [ARIA13: aria-labelledby to name regions and landmarks](https://www.w3.org/WAI/WCAG22/Techniques/aria/ARIA13)
* [ARIA specification - Complementary Role](https://www.w3.org/TR/wai-aria-1.2/#complementary)
### Who does this affect?
* People using a screen reader, including blind, low vision, and neurodivergent people
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>