Bootstrap Vue Pagination Component
Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages.
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".
<CPagination aria-label="Page navigation example">
<CPaginationItem href="#">Previous</CPaginationItem>
<CPaginationItem href="#">1</CPaginationItem>
<CPaginationItem href="#">2</CPaginationItem>
<CPaginationItem href="#">3</CPaginationItem>
<CPaginationItem href="#">Next</CPaginationItem>
</CPagination>
2
3
4
5
6
7
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.
<CPagination aria-label="Page navigation example">
<CPaginationItem aria-label="Previous" href="#"><span aria-hidden="true">«</span></CPaginationItem>
<CPaginationItem href="#">1</CPaginationItem>
<CPaginationItem href="#">2</CPaginationItem>
<CPaginationItem href="#">3</CPaginationItem>
<CPaginationItem aria-label="Next" href="#"><span aria-hidden="true">»</span></CPaginationItem>
</CPagination>
2
3
4
5
6
7
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 prop 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, we always add tabindex="-1" on disabled links and use custom JavaScript to fully disable their functionality.
<CPagination aria-label="Page navigation example">
<CPaginationItem aria-label="Previous" href="#" disabled><span aria-hidden="true">«</span></CPaginationItem>
<CPaginationItem href="#" active>1</CPaginationItem>
<CPaginationItem href="#">2</CPaginationItem>
<CPaginationItem href="#">3</CPaginationItem>
<CPaginationItem aria-label="Next" href="#"><span aria-hidden="true">»</span></CPaginationItem>
</CPagination>
2
3
4
5
6
7
Sizing
Fancy larger or smaller pagination? Add size="lg" or size="sm" for additional sizes.
<CPagination size="lg" aria-label="Page navigation example">
<CPaginationItem href="#">Previous</CPaginationItem>
<CPaginationItem href="#">1</CPaginationItem>
<CPaginationItem href="#">2</CPaginationItem>
<CPaginationItem href="#">3</CPaginationItem>
<CPaginationItem href="#">Next</CPaginationItem>
</CPagination>
2
3
4
5
6
7
<CPagination size="sm" aria-label="Page navigation example">
<CPaginationItem href="#">Previous</CPaginationItem>
<CPaginationItem href="#">1</CPaginationItem>
<CPaginationItem href="#">2</CPaginationItem>
<CPaginationItem href="#">3</CPaginationItem>
<CPaginationItem href="#">Next</CPaginationItem>
</CPagination>
2
3
4
5
6
7
Alignment
Change the alignment of pagination components with align property.
<CPagination align="center" aria-label="Page navigation example">
<CPaginationItem disabled>Previous</CPaginationItem>
<CPaginationItem href="#">1</CPaginationItem>
<CPaginationItem href="#">2</CPaginationItem>
<CPaginationItem href="#">3</CPaginationItem>
<CPaginationItem href="#">Next</CPaginationItem>
</CPagination>
2
3
4
5
6
7
<CPagination align="end" aria-label="Page navigation example">
<CPaginationItem disabled>Previous</CPaginationItem>
<CPaginationItem href="#">1</CPaginationItem>
<CPaginationItem href="#">2</CPaginationItem>
<CPaginationItem href="#">3</CPaginationItem>
<CPaginationItem href="#">Next</CPaginationItem>
</CPagination>
2
3
4
5
6
7
API
CPagination
import { CPagination } from '@coreui/bootstrap-vue'
// or
import CPagination from '@coreui/bootstrap-vue/src/components/pagination/CPagination'
2
3
Props
| Prop name | Description | Type | Values | Default |
|---|---|---|---|---|
| align | Set the alignment of pagination components. | string | 'start', 'center', 'end' | - |
| size | Size the component small or large. | string | 'sm', 'lg' | - |
CPaginationItem
import { CPaginationItem } from '@coreui/bootstrap-vue'
// or
import CPaginationItem from '@coreui/bootstrap-vue/src/components/pagination/CPaginationItem'
2
3
Props
| Prop name | Description | Type | Values | Default |
|---|---|---|---|---|
| active | Toggle the active state for the component. | boolean | - | |
| component | Component used for the root node. Either a string to use a HTML element or a component. | string | - | - |
| disabled | Toggle the disabled state for the component. | boolean | - | |
| href | The href attribute specifies the URL of the page the link goes to. | string | - | - |