Back to Pagination
View full API on Pagination
Pagination
Page links
Previous, numbered pages, ellipsis, and next.
API
| Prop | Type | Default | Description |
|---|---|---|---|
| page / defaultPage | number | — | Current page (1-indexed). |
| totalPages* | number | — | Total number of pages. |
| onPageChange | (page: number) => void | — | Called when the user selects a new page. |
| getHref | (page: number) => string | — | When set, renders anchor links instead of buttons. |
| siblingCount | number | 1 | Pages shown on each side of the current page. |
| boundaryCount | number | 1 | Pages always shown at the start and end. |
| showFirstLast | boolean | false | Show jump-to-first/last controls. |
| hideOnSinglePage | boolean | false | Render nothing when `totalPages` is 1. |
| isActive (PaginationLink) | boolean | — | Marks the current page with `aria-current="page"`. |
| size | "sm" | "md" | "lg" | "icon" | icon | Control size from the Button scale. |