React Smart Pagination Component API

Smart Pagination API

Explore the API reference for the React Smart Pagination component and discover how to effectively utilize its props for customization.

On this page

CSmartPagination#

import { CSmartPagination } from '@coreui/react-pro'
// or
import CSmartPagination from '@coreui/react-pro/src/components/smart-pagination/CSmartPagination'
PropertyDefaultType
activePage#1number

Current page number.

align#start'start', 'center', 'end'

Horizontall align.

arrows#trueboolean

Show/hide arrows.

className#-string

A string of all className you want applied to the base component.

dots#trueboolean

Show/hide dots.

doubleArrows#trueboolean

Show double arrows buttons.

firstButton#<React.Fragment>&laquo;</React.Fragment>ReactNode

The content of firstButton button.

lastButton#<React.Fragment>&raquo;</React.Fragment>ReactNode

The content of lastButton button.

limit#5number

Maximum items number.

nextButton#<React.Fragment>&rsaquo;</React.Fragment>ReactNode

The content of nextButton button.

onActivePageChange#-(activePage: number) => void

On active page change callback.

pages#-number

Number of pages.

previousButton#<React.Fragment>&lsaquo;</React.Fragment>ReactNode

The content of previousButton button.

size#-'sm', 'lg'

Size of pagination, valid values: 'sm', 'lg'.