accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
101 lines (86 loc) • 4.29 kB
HTML
<html lang="en-US">
<head>
<title>aria_complementary_label_visible - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"Pass_0":"Rule Passed","Fail_1":"Element with \"complementary\" role does not have a visible label","group":"Each element with \"complementary\" role should have a visible label that describes its purpose"}};
RULE_ID = "aria_complementary_label_visible"
</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?
Elements with a `"complementary"` role are a type of region used to enclose content that is complementary to the main content on the page.
Providing a visible label for each `"complementary"` region on the page provides better context for all users including people using assistive technologies.
These landmark labels help to identify and navigate to the content.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* For each `<aside>` element or element with `role="complementary"`, set the value of the `aria-labelledby` attribute to the `id` value of any visible text that appropriately and uniquely describes the complementary content.
For example:
```
<h1 id="weather">Weather portlet</h1>
<div role="complementary" aria-labelledby="weather">
...
</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)
* [ARIA specification - complementary role](https://www.w3.org/TR/wai-aria-1.2/#complementary)
* [ARIA practices - Landmark Regions](https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/)
* [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>