diff options
Diffstat (limited to 'vendor/twbs/bootstrap/site/docs/4.5/components/pagination.md')
| -rw-r--r-- | vendor/twbs/bootstrap/site/docs/4.5/components/pagination.md | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/vendor/twbs/bootstrap/site/docs/4.5/components/pagination.md b/vendor/twbs/bootstrap/site/docs/4.5/components/pagination.md new file mode 100644 index 000000000..b1f8e58a2 --- /dev/null +++ b/vendor/twbs/bootstrap/site/docs/4.5/components/pagination.md @@ -0,0 +1,174 @@ +--- +layout: docs +title: Pagination +description: Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages. +group: components +toc: 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 %} +<nav aria-label="Page navigation example"> + <ul class="pagination"> + <li class="page-item"><a class="page-link" href="#">Previous</a></li> + <li class="page-item"><a class="page-link" href="#">1</a></li> + <li class="page-item"><a class="page-link" href="#">2</a></li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + <li class="page-item"><a class="page-link" href="#">Next</a></li> + </ul> +</nav> +{% 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 %} +<nav aria-label="Page navigation example"> + <ul class="pagination"> + <li class="page-item"> + <a class="page-link" href="#" aria-label="Previous"> + <span aria-hidden="true">«</span> + </a> + </li> + <li class="page-item"><a class="page-link" href="#">1</a></li> + <li class="page-item"><a class="page-link" href="#">2</a></li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + <li class="page-item"> + <a class="page-link" href="#" aria-label="Next"> + <span aria-hidden="true">»</span> + </a> + </li> + </ul> +</nav> +{% 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 %} +<nav aria-label="..."> + <ul class="pagination"> + <li class="page-item disabled"> + <a class="page-link" href="#" tabindex="-1" aria-disabled="true">Previous</a> + </li> + <li class="page-item"><a class="page-link" href="#">1</a></li> + <li class="page-item active" aria-current="page"> + <a class="page-link" href="#">2 <span class="sr-only">(current)</span></a> + </li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + <li class="page-item"> + <a class="page-link" href="#">Next</a> + </li> + </ul> +</nav> +{% 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 %} +<nav aria-label="..."> + <ul class="pagination"> + <li class="page-item disabled"> + <span class="page-link">Previous</span> + </li> + <li class="page-item"><a class="page-link" href="#">1</a></li> + <li class="page-item active" aria-current="page"> + <span class="page-link"> + 2 + <span class="sr-only">(current)</span> + </span> + </li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + <li class="page-item"> + <a class="page-link" href="#">Next</a> + </li> + </ul> +</nav> +{% endcapture %} +{% include example.html content=example %} + +## Sizing + +Fancy larger or smaller pagination? Add `.pagination-lg` or `.pagination-sm` for additional sizes. + +{% capture example %} +<nav aria-label="..."> + <ul class="pagination pagination-lg"> + <li class="page-item active" aria-current="page"> + <span class="page-link"> + 1 + <span class="sr-only">(current)</span> + </span> + </li> + <li class="page-item"><a class="page-link" href="#">2</a></li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + </ul> +</nav> +{% endcapture %} +{% include example.html content=example %} + +{% capture example %} +<nav aria-label="..."> + <ul class="pagination pagination-sm"> + <li class="page-item active" aria-current="page"> + <span class="page-link"> + 1 + <span class="sr-only">(current)</span> + </span> + </li> + <li class="page-item"><a class="page-link" href="#">2</a></li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + </ul> +</nav> +{% 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 %} +<nav aria-label="Page navigation example"> + <ul class="pagination justify-content-center"> + <li class="page-item disabled"> + <a class="page-link" href="#" tabindex="-1" aria-disabled="true">Previous</a> + </li> + <li class="page-item"><a class="page-link" href="#">1</a></li> + <li class="page-item"><a class="page-link" href="#">2</a></li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + <li class="page-item"> + <a class="page-link" href="#">Next</a> + </li> + </ul> +</nav> +{% endcapture %} +{% include example.html content=example %} + +{% capture example %} +<nav aria-label="Page navigation example"> + <ul class="pagination justify-content-end"> + <li class="page-item disabled"> + <a class="page-link" href="#" tabindex="-1" aria-disabled="true">Previous</a> + </li> + <li class="page-item"><a class="page-link" href="#">1</a></li> + <li class="page-item"><a class="page-link" href="#">2</a></li> + <li class="page-item"><a class="page-link" href="#">3</a></li> + <li class="page-item"> + <a class="page-link" href="#">Next</a> + </li> + </ul> +</nav> +{% endcapture %} +{% include example.html content=example %} |