accessibility-checker-engine
Version:
An automated accessibility checking engine for use by other tools
99 lines (84 loc) • 4.1 kB
HTML
<html lang="en-US">
<head>
<title>aria_parent_required - Accessibility Checker Help</title>
<script>
RULE_MESSAGES = {"en-US":{"group":"Each element with an implicit or explicit role must be contained within a valid element","Pass_0":"Rule Passed","Fail_1":"Element with \"{0}\" role is not contained in or owned by an element with one of the following roles: \"{1}\""}};
RULE_ID = "aria_parent_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?
If an ARIA `role` attribute is specified for an element, the parent element that is required for that role must also be present in the accessibility tree.
If the parent element's implicit role satisfies the requirement (e.g., `<ul>`), this role does not have to be explicitly set with ARIA.
Without the required parent element, assistive technologies may not be able to accurately represent or interact with the element.
<!-- This is where the code snippet is injected -->
<div id="locSnippet"></div>
### What to do
* Add one of the required context role(s) to the appropriate parent of this element.
For example, the following `<li>` element uses an `"option"` role.
The `"option"` role requires a parent element with role `"listbox"`:
```
<ul role="listbox">
<li role="option">list box option</li>
</ul>
```
</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 1.3.1 Info and Relationships](https://www.ibm.com/able/requirements/requirements/#1_3_1)
* [ARIA - Required Context Role](https://www.w3.org/TR/wai-aria/#scope)
### Who does this affect?
* People using a screen reader, including blind, low vision, and neurodivergent people
</script></mark-down>
<!-- End side panel -->
</div>
</div>
</div>
</body>
</html>