Iframe has an accessible name

  • Rule Typeatomic
  • Rule ID: cae760
  • Last modified: Aug 21, 2019
  • Accessibility Requirements Mapping
    • 4.1.2 Name, Role, Value (Level: A)
      • Learn More about 4.1.2 (Name, Role, Value)
      • Required for conformance to WCAG 2.0 and above on level A and above
      • Outcome mapping:
        • Any failed outcomes: not satisfied
        • All passed outcomes: further testing is needed
        • An inapplicable outcome: further testing is needed
  • Input Aspects

Description

This rule checks that each iframe element has an accessible name.

Applicability

The rule applies to iframe elements that are included in the accessibility tree.

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 only whitespace.

Assumptions

Accessibility Support

There are no major accessibility support issues known for this rule.

Background

Test Cases

Passed

Passed Example 1

Usage of title attribute to describe the iframe content.

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

Passed Example 2

Usage of aria-label attribute to describe the iframe content.

<iframe aria-label="Advertisement of tours to Great Wall of China" src="../test-assets/SC4-1-2-frame-doc.html">
</iframe>

Passed Example 3

Usage of aria-labelledby attribute to describe the iframe content.

<div id="frame-title-helper">Watch highlights of the Worldcup</div>
<iframe aria-labelledby="frame-title-helper" src="../test-assets/SC4-1-2-frame-doc.html"> </iframe>

Passed Example 4

Accessible name is not only whitespace.

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

Failed

Failed Example 1

Usage of name attribute to describe the iframe content is not valid.

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

Failed Example 2

iframe with no title, aria-label or aria-labelledby attribute to describe content is not valid.

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

Failed Example 3

Empty title attribute is not valid.

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

Failed Example 4

Empty aria-label attribute to describe the frame content is not valid.

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

Failed Example 5

Usage of non existing aria-labelledby reference element to describe the iframe content is not valid.

<iframe aria-labelledby="does-not-exist" src="../test-assets/SC4-1-2-frame-doc.html"> </iframe>

Failed Example 6

Usage of alt attribute to describe content is not valid.

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

Failed Example 7

Accessible name is only whitespace.

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

Inapplicable

Inapplicable Example 1

Does not apply to non iframe element.

<button>take me somewhere</button>

Inapplicable Example 2

iframe is not included in the accessibility tree.

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

Glossary

Accessible Name

key: accessible-name

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 (work in progress) and SVG Accessibility API Mappings, Name and Description (work in progress).

Included in the accessibility tree

key: included-in-the-accessibility-tree

Elements included in the accessibility tree of platform specific accessibility APIs. Elements in the accessibility tree are exposed to assistive technologies, allowing users to interact with the elements in a way that meet 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 (work in progress) and the SVG accessibility API mappings (work in progress).

Note: Users of assistive technologies might still be able to interact with elements that are not included in the accessibility tree. An example of this is a focusable element with an aria-hidden attribute with a value of true. Such an element could still be interacted with using sequential keyboard navigation regardless of the assistive technologies used, even though the element would not be included in the accessibility tree.

Outcome

key: outcome

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:

  • Inapplicable: No part of the test subject matches the applicability
  • Passed: A test target meets all expectations
  • Failed: A test target does not meet all expectations

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: Implementers 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.

Whitespace

key: whitespace

Characters that have the Unicode "White_Space" property in the Unicode properties list.

This includes:

  • all characters in the Unicode Separator categories, and
  • the following characters in the Other, Control category:

    • Character tabulation (U+0009)
    • Line Feed (LF) (U+000A)
    • Line Tabulation (U+000B)
    • Form Feed (FF) (U+000C)
    • Carriage Return (CR) (U+000D)
    • Next Line (NEL) (U+0085)

Changelog

Aug 21, 2019test: add tests to verify h4 headings (#810)
Aug 21, 2019fix: update links to WCAG21 resources (#776)
Aug 21, 2019Editorial changes (#725)
Jul 26, 2019Editorial changes (#702)
Jul 19, 2019chore: run prettier (#688)
Jul 17, 2019chore: Various typos (#667)
Jul 2, 2019chore: Correct various typos (#640)
May 18, 2019chore: Validating rules frontmatter on CI (#551)
May 15, 2019Glossary and Rule update: Replacing "non-empty" definition (#430)
May 9, 2019Chore: Adapt site to ACT Rules CR format (#547)
May 7, 2019Template update - iframe has an accessible name (#512)
Apr 29, 2019chore: rename files and update associations (#489)
Apr 16, 2019chore: add unique id to all rules (#478)
Apr 15, 2019chore: WCAG ACT RULES CG Website Update (#437)
Jan 7, 2019Fix links on "Iframe has accessible name" (#378)
Oct 29, 2018chore: change references to included in accessibility tree (#322)
Oct 9, 2018Fix: testcase generation (#296)
Oct 2, 2018Rule: SC4-1-2-iframe-has-name (#222)

Useful Links


Implementations

Tool NameCreated ByReport
AlfaSiteimproveView Report
Axe-coreDeque SystemsView Report

Acknowledgements