Skip to content

Proposed Test Rule: iframe element has non-empty accessible name

Applicability

This rule applies to iframe elements that are included in the accessibility tree and that can be accessed by sequential focus navigation.

Note: frame element is deprecated, this rule does not consider frame or frameset elements.

Expectation

Each target element has an accessible name that is not empty ("").

Assumptions

If an iframe is not perceived by the user as a single control, it does not qualify as a user interface component under WCAG 2. In such a scenario, failing this rule would not fail success criterion 4.1.2. Unless the iframe is both removed from the accessibility tree and removed from sequential focus navigation, they usually are considered to be user interface components.

Accessibility Support

Background

Bibliography

Accessibility Requirements Mapping

Input Aspects

The following aspects are required in using this rule.

Test Cases

Passed

Passed Example 1

Open in a new tab

This iframe element gets its accessible name from the title attribute.

<iframe title="Grocery List" src="/test-assets/SC4-1-2-frame-doc.html"> </iframe>

Passed Example 2

Open in a new tab

This iframe element gets its accessible name from the aria-label attribute.

<iframe aria-label="Grocery list" src="/test-assets/SC4-1-2-frame-doc.html"> </iframe>

Passed Example 3

Open in a new tab

This iframe element gets its accessible name from the content of the div referenced with the aria-labelledby attribute.

<div id="frame-title-helper">Grocery List</div>
<iframe aria-labelledby="frame-title-helper" src="/test-assets/SC4-1-2-frame-doc.html"> </iframe>

Failed

Failed Example 1

Open in a new tab

This iframe element has an empty ("") accessible name. The name attribute is not used in computing the accessible name of iframe elements.

<iframe name="Grocery List" src="/test-assets/SC4-1-2-frame-doc.html"> </iframe>

Failed Example 2

Open in a new tab

This iframe element has no attributes that would give it a non-empty ("") accessible name.

<iframe src="/test-assets/SC4-1-2-frame-doc.html"> </iframe>

Failed Example 3

Open in a new tab

This iframe element has an empty ("") accessible name because the title attribute has an empty string as its value.

<iframe title="" src="/test-assets/SC4-1-2-frame-doc.html"> </iframe>

Failed Example 4

Open in a new tab

This iframe element has an empty ("") accessible name because the title attribute value is trimmed of whitespace by the accessible name computation.

Note:: Because iframe elements are part of sequential focus navigation, the explicit semantic role of none will be ignored, due to the Presentational Roles Conflict Resolution.

<iframe title=" " src="/test-assets/SC4-1-2-frame-doc.html" role="none"> </iframe>

Inapplicable

Inapplicable Example 1

Open in a new tab

This page has no iframe element.

<button>take me somewhere</button>

Inapplicable Example 2

Open in a new tab

This iframe is not included in the accessibility tree because of setting a style of display: none;.

<iframe style="display:none;" src="/test-assets/SC4-1-2-frame-doc.html"></iframe>

Inapplicable Example 3

Open in a new tab

This iframe element has a negative tabindex and therefore is not included in the sequential focus navigation.

<iframe tabindex="-1" src="/test-assets/SC4-1-2-frame-doc.html"> </iframe>

Glossary

Accessible Name

The accessible name is the programmatically determined name of a user interface element that is included in the accessibility tree.

The accessible name is calculated using the accessible name and description computation.

For native markup languages, such as HTML and SVG, additional information on how to calculate the accessible name can be found in HTML Accessibility API Mappings 1.0, Accessible Name and Description Computation (working draft) and SVG Accessibility API Mappings, Name and Description (working draft).

For more details, see examples of accessible name.

Note: As per the accessible name and description computation, each element always has an accessible name. When no accessible name is provided, the element will nonetheless be assigned an empty ("") one.

Note: As per the accessible name and description computation, accessible names are flat string trimmed of leading and trailing whitespace. Notably, it is not possible for a non-empty accessible name to be composed only of whitespace since these must be trimmed.

Explicit Semantic Role

The explicit semantic role of an element is determined by its role attribute (if any).

The role attribute takes a list of tokens. The explicit semantic role is the first valid role in this list. The valid roles are all non-abstract roles from WAI-ARIA Specifications. If the element has no role attribute, or if it has one with no valid role, then this element has no explicit semantic role.

Other roles may be added as they become available. Not all roles will be supported in all assistive technologies. Testers are encouraged to adjust which roles are allowed according to the accessibility support base line. For the purposes of executing test cases in all rules, it should be assumed that all roles are supported by assistive technologies so that none of the roles fail due to lack of accessibility support.

Focusable

An element is focusable if one or both of the following are true:

Exception: Elements that lose focus during a period of up to 1 second after gaining focus, without the user interacting with the page the element is on, are not considered focusable.

Notes:

Included in the accessibility tree

Elements included in the accessibility tree of platform specific accessibility APIs are exposed to assistive technologies. This allows users of assistive technology to access the elements in a way that meets the requirements of the individual user.

The general rules for when elements are included in the accessibility tree are defined in the core accessibility API mappings. For native markup languages, such as HTML and SVG, additional rules for when elements are included in the accessibility tree can be found in the HTML accessibility API mappings (working draft) and the SVG accessibility API mappings (working draft).

For more details, see examples of included in the accessibility tree.

Programmatically hidden elements are removed from the accessibility tree. However, some browsers will leave focusable elements with an aria-hidden attribute set to true in the accessibility tree. Because they are hidden, these elements are considered not included in the accessibility tree. This may cause confusion for users of assistive technologies because they may still be able to interact with these focusable elements using sequential keyboard navigation, even though the element should not be included in the accessibility tree.

Outcome

An outcome is a conclusion that comes from evaluating an ACT Rule on a test subject or one of its constituent test target. An outcome can be one of the three following types:

Note: A rule has one passed or failed outcome for every test target. When there are no test targets the rule has one inapplicable outcome. This means that each test subject will have one or more outcomes.

Note: Implementations using the EARL10-Schema can express the outcome with the outcome property. In addition to passed, failed and inapplicable, EARL 1.0 also defined an incomplete outcome. While this cannot be the outcome of an ACT Rule when applied in its entirety, it often happens that rules are only partially evaluated. For example, when applicability was automated, but the expectations have to be evaluated manually. Such “interim” results can be expressed with the incomplete outcome.

Programmatically Hidden

An HTML element is programmatically hidden if either it has a computed CSS property visibility whose value is not visible; or at least one of the following is true for any of its inclusive ancestors in the flat tree:

Note: Contrarily to the other conditions, the visibility CSS property may be reverted by descendants.

Note: The HTML standard suggests rendering elements with the hidden attribute with a CSS rule that applies the value none to the CSS property display of the element. Although the suggestion is not normative, known user agents render it according to the suggestion (unless the content specifies another CSS rule that sets the value of the display property). If a user agent does not follow the suggestion, this definition may produce incorrect results for this user agent.

WAI-ARIA specifications

The WAI ARIA Specifications group both the WAI ARIA W3C Recommendation and ARIA modules, namely:

Note: depending on the type of content being evaluated, part of the specifications might be irrelevant and should be ignored.

Whitespace

Whitespace are characters that have the Unicode “White_Space” property in the Unicode properties list.

This includes:

Implementations

This section is not part of the official rule. It is populated dynamically and not accounted for in the change history or the last modified date.

Implementation Consistency Complete Report
QualWeb Consistent Yes View Report
SortSite Consistent No View Report

Changelog

This is the first version of this ACT rule.

Back to Top

This is an unpublished draft preview that might include content that is not yet approved. The published website is at w3.org/WAI/.