accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
98 lines (82 loc) • 4.16 kB
HTML
<html lang="en-US">
<head>
<title>label_name_visible - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"Pass_0":"Accessible name matches or contains the visible label text","Fail_1":"Accessible name does not match or contain the visible label text","group":"Accessible name must match or contain the visible label text"}};
RULE_ID = "label_name_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/v2.51.1/code-snippet.min.js";
import "https://1.www.s81c.com/common/carbon/web-components/version/v2.51.1/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?
Speech-input users navigate to an input field by speaking the visible field label (i.e., text displayed on the screen).
Their verbal command activates the interactive component’s programmatic [accessible name](https://www.w3.org/TR/accname-1.2/#dfn-accessible-name) and sets focus to the component.
A point of failure occurs when the visible label and the accessible name are different, or the visible label text string is not contained within the accessible name value.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Provide an [accessible name value](https://www.w3.org/TR/wai-aria-1.2/#namecalculation) that matches or contains the visible label for this control. For example:
```
<button name="pageLink" aria-label="Next Page in the list">Next Page</button>
<label for="test2">License Number:</label>
<input type="text" id="test2" aria-label="enter driver license number"/>
<button name="lastPageLink" aria-label="last page">Last Page</button>
```
</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.5.3 Label in Name](https://www.ibm.com/able/requirements/requirements/#2_5_3)
### Who does this affect?
* People with dexterity impairments using voice control
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>