5f1bc4a756
* Replace visually hidden span with aria-current in tests * Remove redundant visually hidden "(current)" when `aria-current` already used Closes #31891
6.3 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Pagination | Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages. | components | true |
Overview
We use a large block of connected links for our pagination, making links hard to miss and easily scalable—all while providing large hit areas. Pagination is built with list HTML elements so screen readers can announce the number of available links. Use a wrapping <nav> element to identify it as a navigation section to screen readers and other assistive technologies.
In addition, as pages likely have more than one such navigation section, it's advisable to provide a descriptive aria-label for the <nav> to reflect its purpose. For example, if the pagination component is used to navigate between a set of search results, an appropriate label could be aria-label="Search results pages".
{% capture example %}
{% endcapture %} {% include example.html content=example %}Working with icons
Looking to use an icon or symbol in place of text for some pagination links? Be sure to provide proper screen reader support with aria attributes.
{% capture example %}
{% endcapture %} {% include example.html content=example %}Disabled and active states
Pagination links are customizable for different circumstances. Use .disabled for links that appear un-clickable and .active to indicate the current page.
While the .disabled class uses pointer-events: none to try to disable the link functionality of <a>s, that CSS property is not yet standardized and doesn't account for keyboard navigation. As such, you should always add tabindex="-1" on disabled links and use custom JavaScript to fully disable their functionality.
{% capture example %}
{% endcapture %} {% include example.html content=example %}You can optionally swap out active or disabled anchors for <span>, or omit the anchor in the case of the prev/next arrows, to remove click functionality and prevent keyboard focus while retaining intended styles.
{% capture example %}
{% endcapture %} {% include example.html content=example %}Sizing
Fancy larger or smaller pagination? Add .pagination-lg or .pagination-sm for additional sizes.
{% capture example %}
{% endcapture %} {% include example.html content=example %}{% capture example %}
{% endcapture %} {% include example.html content=example %}Alignment
Change the alignment of pagination components with [flexbox utilities]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/flex/).
{% capture example %}
{% endcapture %} {% include example.html content=example %}{% capture example %}
{% endcapture %} {% include example.html content=example %}