React Pagination Component

Pagination

Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages.

Other frameworks

CoreUI components are available as native Angular, Bootstrap (Vanilla JS), and Vue components. To learn more please visit the following pages.

On this page

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>Previous</CPaginationItem>
  <CPaginationItem>1</CPaginationItem>
  <CPaginationItem>2</CPaginationItem>
  <CPaginationItem>3</CPaginationItem>
  <CPaginationItem>Next</CPaginationItem>
</CPagination>

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">
    <span aria-hidden="true">&laquo;</span>
  </CPaginationItem>
  <CPaginationItem>1</CPaginationItem>
  <CPaginationItem>2</CPaginationItem>
  <CPaginationItem>3</CPaginationItem>
  <CPaginationItem aria-label="Next">
    <span aria-hidden="true">&raquo;</span>
  </CPaginationItem>
</CPagination>

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" disabled>
    <span aria-hidden="true">&laquo;</span>
  </CPaginationItem>
  <CPaginationItem active>1</CPaginationItem>
  <CPaginationItem>2</CPaginationItem>
  <CPaginationItem>3</CPaginationItem>
  <CPaginationItem aria-label="Next">
    <span aria-hidden="true">&raquo;</span>
  </CPaginationItem>
</CPagination>

Sizing#

Fancy larger or smaller pagination? Add size="lg" or size="sm" for additional sizes.

<CPagination size="lg" aria-label="Page navigation example">
  <CPaginationItem>Previous</CPaginationItem>
  <CPaginationItem>1</CPaginationItem>
  <CPaginationItem>2</CPaginationItem>
  <CPaginationItem>3</CPaginationItem>
  <CPaginationItem>Next</CPaginationItem>
</CPagination>

<CPagination size="sm" aria-label="Page navigation example">
  <CPaginationItem>Previous</CPaginationItem>
  <CPaginationItem>1</CPaginationItem>
  <CPaginationItem>2</CPaginationItem>
  <CPaginationItem>3</CPaginationItem>
  <CPaginationItem>Next</CPaginationItem>
</CPagination>

Alignment#

Change the alignment of pagination components with align property.

<CPagination align="center" aria-label="Page navigation example">
  <CPaginationItem disabled>Previous</CPaginationItem>
  <CPaginationItem>1</CPaginationItem>
  <CPaginationItem>2</CPaginationItem>
  <CPaginationItem>3</CPaginationItem>
  <CPaginationItem>Next</CPaginationItem>
</CPagination>

<CPagination align="end" aria-label="Page navigation example">
  <CPaginationItem disabled>Previous</CPaginationItem>
  <CPaginationItem>1</CPaginationItem>
  <CPaginationItem>2</CPaginationItem>
  <CPaginationItem>3</CPaginationItem>
  <CPaginationItem>Next</CPaginationItem>
</CPagination>

Customizing#

CSS variables#

React pagination use local CSS variables on .pagination for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

--cui-pagination-padding-x: #{$pagination-padding-x};
--cui-pagination-padding-y: #{$pagination-padding-y};
@include rfs($pagination-font-size, --cui-pagination-font-size);
--cui-pagination-color: #{$pagination-color};
--cui-pagination-bg: #{$pagination-bg};
--cui-pagination-border-width: #{$pagination-border-width};
--cui-pagination-border-color: #{$pagination-border-color};
--cui-pagination-border-radius: #{$pagination-border-radius};
--cui-pagination-hover-color: #{$pagination-hover-color};
--cui-pagination-hover-bg: #{$pagination-hover-bg};
--cui-pagination-hover-border-color: #{$pagination-hover-border-color};
--cui-pagination-focus-color: #{$pagination-focus-color};
--cui-pagination-focus-bg: #{$pagination-focus-bg};
--cui-pagination-focus-box-shadow: #{$pagination-focus-box-shadow};
--cui-pagination-active-color: #{$pagination-active-color};
--cui-pagination-active-bg: #{$pagination-active-bg};
--cui-pagination-active-border-color: #{$pagination-active-border-color};
--cui-pagination-disabled-color: #{$pagination-disabled-color};
--cui-pagination-disabled-bg: #{$pagination-disabled-bg};
--cui-pagination-disabled-border-color: #{$pagination-disabled-border-color};

How to use CSS variables#

const vars = { 
  '--my-css-var': 10,
  '--my-another-css-var': "red" 
}
return <CPagination style={vars}>...</CCard>

SASS variables#

$pagination-padding-y:              .375rem !default;
$pagination-padding-x:              .75rem !default;
$pagination-padding-y-sm:           .25rem !default;
$pagination-padding-x-sm:           .5rem !default;
$pagination-padding-y-lg:           .75rem !default;
$pagination-padding-x-lg:           1.5rem !default;

$pagination-font-size:              $font-size-base !default;

$pagination-color:                  var(--cui-link-color) !default;
$pagination-bg:                     var(--cui-body-bg) !default;
$pagination-border-radius:          var(--cui-border-radius) !default;
$pagination-border-width:           var(--cui-border-width) !default;
$pagination-margin-start:           calc(#{$pagination-border-width} * -1) !default; // stylelint-disable-line function-disallowed-list
$pagination-border-color:           var(--cui-border-color) !default;

$pagination-focus-color:            var(--cui-link-hover-color) !default;
$pagination-focus-bg:               var(--cui-secondary-bg) !default;
$pagination-focus-box-shadow:       $focus-ring-box-shadow !default;
$pagination-focus-outline:          0 !default;

$pagination-hover-color:            var(--cui-link-hover-color) !default;
$pagination-hover-bg:               var(--cui-tertiary-bg) !default;
$pagination-hover-border-color:     var(--cui-border-color) !default; // Todo in v6: remove this?

$pagination-active-color:           $component-active-color !default;
$pagination-active-bg:              $component-active-bg !default;
$pagination-active-border-color:    $component-active-bg !default;

$pagination-disabled-color:         var(--cui-secondary-color) !default;
$pagination-disabled-bg:            var(--cui-secondary-bg) !default;
$pagination-disabled-border-color:  var(--cui-border-color) !default;

$pagination-transition:              color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out !default;

$pagination-border-radius-sm:       var(--cui-border-radius-sm) !default;
$pagination-border-radius-lg:       var(--cui-border-radius-lg) !default;

API#

CPagination#

import { CPagination } from '@coreui/react'
// or
import CPagination from '@coreui/react/src/components/pagination/CPagination'

Property	Description	Type	Default
align	Set the alignment of pagination components.	`'start'` \| `'center'` \| `'end'`	-
className	A string of all className you want applied to the base component.	`string`	-
size	Size the component small or large.	`'sm'` \| `'lg'`	-

CPaginationItem#

import { CPaginationItem } from '@coreui/react'
// or
import CPaginationItem from '@coreui/react/src/components/pagination/CPaginationItem'

Property	Description	Type	Default
active	Toggle the active state for the component.	`boolean`	-
as	Component used for the root node. Either a string to use a HTML element or a component.	`(ElementType & string)` \| `(ElementType & ComponentClass<any, any>)` \| `(ElementType & FunctionComponent<any>)`	-
disabled	Toggle the disabled state for the component.	`boolean`	-