Pagination
Page navigation with numbered links.
Installation
Usage
Examples
Many pages
Previous/next controls with an ellipsis over skipped ranges.
Small size
Compact page buttons.
Compact
Previous/next around a page counter.
API reference
Pagination
| Prop | Type | Default |
|---|---|---|
childrenUsually a single PaginationContent. | ReactNode | - |
classNameAdditional classes merged on the nav element. | string | - |
PaginationContent
| Prop | Type | Default |
|---|---|---|
childrenPaginationItem elements. | ReactNode | - |
classNameAdditional classes merged with the default row styles. | string | - |
PaginationItem
| Prop | Type | Default |
|---|---|---|
childrenOne link, control, or ellipsis. | ReactNode | - |
classNameAdditional classes merged on the list item. | string | - |
PaginationLink
| Prop | Type | Default |
|---|---|---|
hrefLink target. Renders a native anchor. | string | - |
isActiveHighlight as the current page with aria-current. | boolean | false |
variantButton style. Active links render outline regardless. | "default" | "secondary" | "outline" | "ghost" | "destructive" | "link" | "ghost" |
sizeButton size. | "default" | "xs" | "sm" | "lg" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | "icon" |
classNameAdditional classes merged with the button styles. | string | - |
PaginationPrevious
| Prop | Type | Default |
|---|---|---|
hrefLink target. Renders a native anchor. | string | - |
childrenLabel beside the arrow. Hidden below the sm breakpoint. | ReactNode | "Previous" |
classNameAdditional classes merged with the default styles. | string | - |
PaginationNext
| Prop | Type | Default |
|---|---|---|
hrefLink target. Renders a native anchor. | string | - |
childrenLabel beside the arrow. Hidden below the sm breakpoint. | ReactNode | "Next" |
classNameAdditional classes merged with the default styles. | string | - |
PaginationEllipsis
| Prop | Type | Default |
|---|---|---|
classNameAdditional classes merged with the default ellipsis styles. | string | - |