accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
99 lines (84 loc) • 4.18 kB
HTML
<html lang="en-US">
<head>
<title>aria_child_tabbable - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"pass":"Rule Passed","fail_missing_child":"None of the descendent elements with \"{1}\" role is tabbable","group":"UI component must have at least one tabbable descendant for keyboard access"}};
RULE_ID = "aria_child_tabbable"
</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?
Setting the `tabindex` value to 0 or -1 on a child element not focusable by default ensures the UI component will be included in the tab sequence and receive focus for keyboard access.
Using values greater than 0 should be avoided as it can break the logical tab order.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Set the value of the `tabindex` attribute equal to 0 or -1 on at least one of the required child elements to include the UI component in the tab sequence.
The following example shows a component with `role="tree"` with its required child with `role="treeitem"`.
The child contains `tabindex="0"` which makes the `treeitem` keyboard-operable:
```
<div role="tree" aria-label="Tree Widget" id="tree1" onkeypress="keyEvent();">
<div id="item1" role="treeitem" tabindex="0">Tree item</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 2.1.1 Keyboard](https://www.ibm.com/able/requirements/requirements/#2_1_1)
* [ARIA practices - Developing a Keyboard Interface](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/)
### Who does this affect?
* People using a screen reader, including blind, low vision, and neurodivergent people
* People who physically cannot use a pointing device
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>