accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
103 lines (88 loc) • 4.82 kB
HTML
<html lang="en-US">
<head>
<title>aria_widget_labelled - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"group":"Interactive component must have a programmatically associated name","Pass_0":"Rule Passed","Fail_1":"Interactive component with ARIA role '{0}' does not have a programmatically associated name"}};
RULE_ID = "aria_widget_labelled"
</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?
Interactive UI components with certain implicit or explicit ARIA roles require an [accessible name](https://www.w3.org/TR/accname-1.2/#dfn-accessible-name).
Without proper labels or the programmatically associated name, assistive technologies may not be able to accurately present the component's name and purpose to the user.
This affects the user’s navigation and ability to interact with the content.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Use the `aria-labelledby` attribute to reference existing visible text on the page that can clearly identify the purpose of the component
* **Or**, use the `aria-label` attribute with a short description as its value that can clearly identify the purpose of the component when a visual label is not available
* **Or**, use the `title` attribute to provide a name when the design cannot accommodate a visual label
* **Or**, if the element's role allows it to derive a label from its content, provide the label text as the inner content of the element (e.g., `<button type="submit">Search</button>`)
The following code snippet shows a tree widget labelled with an `aria-labelledby` attribute to reference the heading text:
```
<h1 id="contents">Table of contents</h1>
<div role="tree" aria-labelledby="contents" tabindex="0">...</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 4.1.2 Name, Role, Value](https://www.ibm.com/able/requirements/requirements/#4_1_2)
* [ARIA specification - Widget Roles](https://www.w3.org/TR/wai-aria-1.2/#widget_roles)
* [W3C - Accessible Name and Description Computation](https://www.w3.org/TR/accname-1.2/#mapping_additional_nd)
### Who does this affect?
* People using a screen reader, including blind, low vision, and neurodivergent people
* People with low vision using screen magnification
* People with dexterity impairments using voice control
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>