A navigational aid that provides a detailed list of links to key subjects, names and other important topics covered in the work.


Example 1 — Index with a heading

The label is identified in the aria-labelledby attribute.

<nav role="doc-index" aria-labelledby="idx-hd">
   <h2 id="idx-hd">Name Index</h2>

Relation to ARIA

doc-index is a landmark role.


doc-index is typically used on nav and section elements.

A label must be provided for the role using one of the aria-labelledby, aria-label or title attributes.

For a simplified list of all the elements the role is allowed on, refer to the mapping table in the EPUB Type to ARIA Role Authoring Guide. For the official list of allowed elements, refer to ARIA in HTML.

Related Links