Description

A navigational aid that provides a list of links to the pagebreaks in the content.

Examples

Example 1 — Page list navigation
<nav role="doc-pagelist" aria-labelledby="pg-hd">
   <h2 id="pg-hd">List of Pages</h2>
   <ol>
      <li><a href="#intro.html#pgi">i</a></li>
      <li><a href="#intro.html#pgii">ii</a></li>
      …
      <li><a href="#c01.html#pg001">1</a></li>
      …
   </ol>
</nav>

Relation to ARIA

doc-pagelist is a landmark role.

Usage

doc-pagelist is typically used on nav elements. Refer to page navigation for more information about authoring page lists.

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