accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
104 lines (89 loc) • 4.66 kB
HTML
<html lang="en-US">
<head>
<title>aria_keyboard_handler_exists - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"pass":"Rule Passed","potential_no_keyboard_access":"Verify the <{0}> element with \"{1}\" role has keyboard access","group":"Interactive WAI_ARIA UI components must provide keyboard access"}};
RULE_ID = "aria_keyboard_handler_exists"
</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?
Unlike native HTML form elements, browsers do not provide keyboard support for graphical user interface (GUI) components that are made accessible with ARIA.
Authors need to implement keyboard access using keyboard handlers, such as `onkeydown` or `onkeypress`.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Confirm you can use the keyboard to navigate to and interact with the UI component
* **Or**, if the component is not keyboard accessible, implement `onkeydown` or `onkeypress` keyboard handlers on the element itself using [ARIA practices](https://www.w3.org/TR/wai-aria-practices-1.2)
* **Or**, if the inaccessible component has required children, implement `onkeydown` or `onkeypress` keyboard handlers on all the required children (example below) or a grandchild of each required child
* **Or**, use other methods to provide keyboard access as described in [ARIA practices - Developing a Keyboard Interface](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/)
For example:
```
<div role="tree" id="tree1">
<div id="item1" role="treeitem" tabindex="0" onkeypress="keyEvent()">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 - Patterns](https://www.w3.org/WAI/ARIA/apg/patterns/)
* [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 with low vision
* People with tremors or other movement disorders
* People who rely on keyboard control
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>