Stripped personal data from development repository
view | history | commit | commitdiff
Samo Penic
2019-02-20 83c3f647c35477564b77cbc5b36d37d793d5442a
commit | author | age
83c3f6 1 ---
SP 2 layout: docs
3 title: Pagination
4 description: Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages.
5 group: components
6 toc: true
7 ---
8
9 ## Overview
10
11 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.
12
13 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"`.
14
15 {% capture example %}
16 <nav aria-label="Page navigation example">
17   <ul class="pagination">
18     <li class="page-item"><a class="page-link" href="#">Previous</a></li>
19     <li class="page-item"><a class="page-link" href="#">1</a></li>
20     <li class="page-item"><a class="page-link" href="#">2</a></li>
21     <li class="page-item"><a class="page-link" href="#">3</a></li>
22     <li class="page-item"><a class="page-link" href="#">Next</a></li>
23   </ul>
24 </nav>
25 {% endcapture %}
26 {% include example.html content=example %}
27
28 ## Working with icons
29
30 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.
31
32 {% capture example %}
33 <nav aria-label="Page navigation example">
34   <ul class="pagination">
35     <li class="page-item">
36       <a class="page-link" href="#" aria-label="Previous">
37         <span aria-hidden="true">&laquo;</span>
38       </a>
39     </li>
40     <li class="page-item"><a class="page-link" href="#">1</a></li>
41     <li class="page-item"><a class="page-link" href="#">2</a></li>
42     <li class="page-item"><a class="page-link" href="#">3</a></li>
43     <li class="page-item">
44       <a class="page-link" href="#" aria-label="Next">
45         <span aria-hidden="true">&raquo;</span>
46       </a>
47     </li>
48   </ul>
49 </nav>
50 {% endcapture %}
51 {% include example.html content=example %}
52
53 ## Disabled and active states
54
55 Pagination links are customizable for different circumstances. Use `.disabled` for links that appear un-clickable and `.active` to indicate the current page.
56
57 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.
58
59 {% capture example %}
60 <nav aria-label="...">
61   <ul class="pagination">
62     <li class="page-item disabled">
63       <a class="page-link" href="#" tabindex="-1" aria-disabled="true">Previous</a>
64     </li>
65     <li class="page-item"><a class="page-link" href="#">1</a></li>
66     <li class="page-item active" aria-current="page">
67       <a class="page-link" href="#">2 <span class="sr-only">(current)</span></a>
68     </li>
69     <li class="page-item"><a class="page-link" href="#">3</a></li>
70     <li class="page-item">
71       <a class="page-link" href="#">Next</a>
72     </li>
73   </ul>
74 </nav>
75 {% endcapture %}
76 {% include example.html content=example %}
77
78 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.
79
80 {% capture example %}
81 <nav aria-label="...">
82   <ul class="pagination">
83     <li class="page-item disabled">
84       <span class="page-link">Previous</span>
85     </li>
86     <li class="page-item"><a class="page-link" href="#">1</a></li>
87     <li class="page-item active" aria-current="page">
88       <span class="page-link">
89         2
90         <span class="sr-only">(current)</span>
91       </span>
92     </li>
93     <li class="page-item"><a class="page-link" href="#">3</a></li>
94     <li class="page-item">
95       <a class="page-link" href="#">Next</a>
96     </li>
97   </ul>
98 </nav>
99 {% endcapture %}
100 {% include example.html content=example %}
101
102 ## Sizing
103
104 Fancy larger or smaller pagination? Add `.pagination-lg` or `.pagination-sm` for additional sizes.
105
106 {% capture example %}
107 <nav aria-label="...">
108   <ul class="pagination pagination-lg">
109     <li class="page-item active" aria-current="page">
110       <span class="page-link">
111         1
112         <span class="sr-only">(current)</span>
113       </span>
114     </li>
115     <li class="page-item"><a class="page-link" href="#">2</a></li>
116     <li class="page-item"><a class="page-link" href="#">3</a></li>
117   </ul>
118 </nav>
119 {% endcapture %}
120 {% include example.html content=example %}
121
122 {% capture example %}
123 <nav aria-label="...">
124   <ul class="pagination pagination-sm">
125     <li class="page-item active" aria-current="page">
126       <span class="page-link">
127         1
128         <span class="sr-only">(current)</span>
129       </span>
130     </li>
131     <li class="page-item"><a class="page-link" href="#">2</a></li>
132     <li class="page-item"><a class="page-link" href="#">3</a></li>
133   </ul>
134 </nav>
135 {% endcapture %}
136 {% include example.html content=example %}
137
138 ## Alignment
139
140 Change the alignment of pagination components with [flexbox utilities]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/flex/).
141
142 {% capture example %}
143 <nav aria-label="Page navigation example">
144   <ul class="pagination justify-content-center">
145     <li class="page-item disabled">
146       <a class="page-link" href="#" tabindex="-1" aria-disabled="true">Previous</a>
147     </li>
148     <li class="page-item"><a class="page-link" href="#">1</a></li>
149     <li class="page-item"><a class="page-link" href="#">2</a></li>
150     <li class="page-item"><a class="page-link" href="#">3</a></li>
151     <li class="page-item">
152       <a class="page-link" href="#">Next</a>
153     </li>
154   </ul>
155 </nav>
156 {% endcapture %}
157 {% include example.html content=example %}
158
159 {% capture example %}
160 <nav aria-label="Page navigation example">
161   <ul class="pagination justify-content-end">
162     <li class="page-item disabled">
163       <a class="page-link" href="#" tabindex="-1" aria-disabled="true">Previous</a>
164     </li>
165     <li class="page-item"><a class="page-link" href="#">1</a></li>
166     <li class="page-item"><a class="page-link" href="#">2</a></li>
167     <li class="page-item"><a class="page-link" href="#">3</a></li>
168     <li class="page-item">
169       <a class="page-link" href="#">Next</a>
170     </li>
171   </ul>
172 </nav>
173 {% endcapture %}
174 {% include example.html content=example %}