accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
108 lines (94 loc) • 4.2 kB
HTML
<html lang="en-US">
<head>
<!--
/******************************************************************************
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?
An HTML `<details>` element or an element with an explicit `"group"` role is used to form a logical collection of items in a component,
such as a collection of siblings in a hierarchy.
A group label helps people using assistive technologies to find and navigate the logical collections.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* If there is visible text that appropriately describes the purpose of the group, set the element's `aria-labelledby` attribute to the `id` value of that text (example below)
* **Or**, use the `aria-label` attribute to add a label directly to the element with the `"group"` role
For example:
```
<h2 id="fruit">Fruits</h2>
<p> The following is a grouping of fruits by type</p>
<ul>
<li> <h3 id="tropical">Tropical Fruits</h3>
<ul role="group" aria-labelledby="tropical">
<li>Mango</li>
<li>Papaya</li>
<li>Pineapple</li>
</ul>
</li>
<li> <h3 id="berries">Berries</h3>
<ul role="group" aria-labelledby="berries">
<li>Blueberry</li>
<li>Strawberry</li>
</ul>
</li>
</ul>
```
</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 practices - Examples by Role](https://www.w3.org/WAI/ARIA/apg/example-index/)
* [ARIA specification - group role](https://www.w3.org/TR/wai-aria-1.2/#group)
### 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>