This Wiki page is edited by participants of the WCAG Working Group. It does not necessarily represent consensus and it may have incorrect information or information that is not supported by other Working Group participants, WAI, or W3C. It may also have some very useful information.

Techniques/HTML/Combining adjacent image and text links for the same resource

From WCAG WG
Jump to: navigation, search

H2: Combining adjacent image and text links for the same resource

Status

Applicability

HTML4, HTML5 and XHTML documents that contain links.

This technique relates to:

Description

This objective of this technique is to provide both text and iconic representations of links without making the web page more confusing or difficult for keyboard users or assistive technology users. Since different users finding text and icons more usable, providing both can improve the accessibility of the link.

Many links have both a text and iconic representation adjacent to each other, but rendered in separate <a> elements. Visually they appear to be a single link, but many users encounter them as adjacent identical links. For a keyboard user, it is tedious to navigate through redundant links. For users of assistive technologies, it can be confusing to encounter successive identical links. When the text alternative for the icon is a duplicate of the link text, it is repetitive as screen readers read the description twice.

If the author omitted alternative text from the link image, it would fail Success Criterion 1.1.1 because the text alternative would not serve the same purpose as the graphical link.

This technique provides such links by putting the text and image together in one <a> element and providing null alternative text on the image to eliminate duplication of text. In this way, both representations of the link are provided, but keyboard users only encounter one link and assistive technology that provides users with link lists for a web page do not include duplicate links.

Sometimes such text and the icon link are rendered in separate, adjacent table cells to facilitate page layout. Although WCAG 2 does not prohibit the use of layout tables, CSS-based layouts are recommended in order to retain the defined semantic meaning of the HTML table elements and to conform to the coding practice of separating presentation from content. If CSS is used, this technique can be applied to combine the links.


Examples

Example 1

The icon and text are contained in the same a element.

Example Code - HTML4 / HTML5:

  <a href="products.html">
     <img src="icon.gif" alt="">
     Products page
  </a>

Example 2

A link contains an icon and text, and the site help refers to the icon. The img has a text alternative which is the name used for the icon in the site help, which describes clicking the home page icon.

Example Code (HTML4 / HTML5):

  <a href="foo.htm">
     <img src="house.gif" alt="home page icon">
     Go to the home page
  </a>

Resources

Resources are for information purposes only, no endorsement implied.

Related Techniques

Tests

Procedure

For each <a> element applying this technique:

  1. Check that the <a> element contains text that describes the target of the link
  2. Check that the <a> element contains an img element that has a null alt attribute, that is alt="", or text that supplements the link text and describes the image


Expected Results

  • All checks above are true.

If this is a sufficient technique for a success criterion, failing this test procedure does not necessarily mean that the success criterion has not been satisfied in some other way, only that this technique has not been successfully implemented and can not be used to claim conformance.