Description
A navigational aid that provides a detailed list of links to key subjects, names and other important topics covered in the work.
Examples
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>
…
</nav>Relation to ARIA
doc-index is a landmark role.
Usage
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.
List of all elements allowed on
- a (without an href attribute)
- abbr
- address
- b
- bdi
- bdo
- blockquote
- br
- canvas
- cite
- code
- del
- dfn
- div
- em
- i
- img (with alt text)
- ins
- kbd
- mark
- nav
- output
- p
- pre
- q
- rp
- rt
- ruby
- s
- samp
- section
- small
- span
- strong
- sub
- sup
- table
- tbody
- td
- tfoot
- thead
- th
- tr
- time
- u
- var
- wbr