accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
107 lines (92 loc) • 4.21 kB
HTML
<html lang="en-US">
<head>
<title>aria_attribute_required - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"group":"The required attributes for the element with a role must be defined","pass":"The required attributes for the element with the role are defined","fail_missing":"Element with '{0}' role does not have the required ARIA attribute(s): '{1}'"}};
RULE_ID = "aria_attribute_required"
</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 elements are assigned an ARIA `role`, there are required attributes for that role.
These attributes represent states and properties of the element.
If these are not defined, assistive technologies may not be able to describe the element or its status to users.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Define the missing state or property attributes for the element according to its role.
The following example shows all the required properties defined for the `scrollbar` role:
```
<div id="content1">Lorem ipsum ...</div>
<div
role="scrollbar"
aria-controls="content1"
aria-orientation="vertical"
aria-valuemax="100"
aria-valuemin="0"
aria-valuenow="25">
<div class="scrollhandle"></div>
</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 practices guide](https://www.w3.org/WAI/ARIA/apg/)
* [ARIA specification](https://www.w3.org/TR/wai-aria-1.2/)]
### Who does this affect?
* People using a screen reader, including blind, low vision, and neurodivergent people
* People with dexterity impairments using voice control
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>