Documentation and examples for showing smart pagination to indicate a series of related content exists across multiple pages.
Overview
React smart pagination component consists of button-like styled links, that are arranged side by side in a horizontal list.
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. SmartPagination is built with list HTML elements so screen readers can announce the number of available links. SmartPagination also 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, SmartPagination 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".???
<CSmartPagination
:activePage="6"
:pages="pages"
/>
Sizing
Fancy larger or smaller pagination? Add size="lg" or size="sm" for additional sizes.
<CSmartPagination
:activePage="6"
:pages="10"
size="lg"
<CSmartPagination
:activePage="6"
:pages="10"
size="sm"
Alignment
Change the alignment of pagination components with align="start", align="center" or align="end".
<CSmartPagination
:activePage="6"
:pages="10"
align="center"
/>
<CSmartPagination
:activePage="6"
:pages="10"
align="end"
/>
API
CSmartPagination
import { CSmartPagination } from '@coreui/vue-pro'
// or
import CSmartPagination from '@coreui/vue-pro/src/components/pagination/CSmartPagination'
Props
| Prop name | Description | Type | Values | Default |
|---|---|---|---|---|
| align | Horizontall align@default 'start' | string | - | 'start' |
| active-page | Current page number@default 1 | number | - | 1 |
| arrows | Show/hide arrows@default true | boolean | - | true |
| dots | Show/hide dots@default true | boolean | - | true |
| double-arrows | Show double arrows buttons@default true | boolean | - | true |
| first-button | The content of 'firstButton' button@default '«' | string | - | '«' |
| last-button | The content of 'lastButton' button@default '»' | string | - | '»' |
| limit | Maximum items number@default 5 | number | - | 5 |
| next-button | The content of 'nextButton' button@default '›' | string | - | '›' |
| pages | Number of pages | number | - | 1000 |
| previous-button | The content of 'previousButton' button@default '‹' | string | - | '‹' |
| size | Size of pagination, valid values: 'sm', 'lg' | string | - | - |
Events
| Event name | Description | Properties |
|---|---|---|
| active-page-change | On active page change callback. |