Skip to Content
DocumentationPagination

Pagination

A fully accessible pagination component for navigating through pages of content.

Usage

Examples

Basic

Custom Variant (Emphasis)

Few Pages

Many Pages

Custom Styling

Different Sizes

Non-Responsive

API

Pagination Structure

ComponentDescriptionUsage
PaginationMain component that handles pagination logic and renderingHigh-level component with built-in state management
PaginationRootRoot container for pagination elementsWraps all pagination components for custom implementations
PaginationContentContainer for page numbers and navigation buttonsGroups pagination items together
PaginationInfoDisplays information about items or total countShows contextual information like “Mostrando X itens” or “X total”
PaginationItemWrapper for individual pagination elementsContainer for page numbers, ellipsis, or navigation buttons
PaginationLinkClickable page number buttonInteractive element for page navigation
PaginationPreviousPrevious page navigation buttonNavigates to the previous page
PaginationNextNext page navigation buttonNavigates to the next page
PaginationEllipsisEllipsis indicator for hidden pagesShows when there are hidden pages between visible ones

Pagination

PropertyTypePossible ValuesDefaultDescription
currentPagenumberAny positive integer-The currently active page number.
totalPagesnumberAny positive integer-The total number of pages available.
maxVisibleItemsnumberAny positive integer2 (0 on mobile when responsive)Maximum number of page numbers to show between ellipsis.
onPageChange(page: number) => void--Callback function called when a page is selected.
itemsPerPagenumberAny positive integer-Number of items displayed per page (shown in PaginationInfo).
totalItemsnumberAny positive integer-Total number of items across all pages (shown in PaginationInfo).
responsivebooleantrue, falsetrueEnables responsive behavior that hides info and adjusts visible items on mobile.
size”sm” | “md” | “lg""sm”, “md”, “lg""md”Size variant for all pagination buttons.
classNamestringAny CSS class string-Additional CSS classes for styling customization.

PaginationInfo

PropertyTypePossible ValuesDefaultDescription
countnumberAny positive integer-The number to be displayed.
labelstringAny string”itens”The label text. When “itens”, shows “Mostrando X itens”. Otherwise shows “X label”.
classNamestringAny CSS class string-Additional CSS classes for styling customization.
PropertyTypePossible ValuesDefaultDescription
isActivebooleantrue, falsefalseIndicates if this page is the current active page.
variant”regular” | “emphasis” | “error” | “warning” | “outlined” | “success” | “regular-basic”-“regular”Base visual variant. When active uses the variant; when inactive uses variant-soft (unless overridden by activeVariant/inactiveVariant).
activeVariant”regular” | “emphasis” | “error” | “warning” | “outlined” | “success” | “regular-basic”--Custom variant for the active state. Overrides the default variant behavior when isActive is true.
inactiveVariant”regular” | “emphasis” | “error” | “warning” | “outlined” | “success” | “regular-basic” | “regular-soft” | “emphasis-soft” | “error-soft” | “warning-soft” | “outlined-soft” | “success-soft” | “regular-basic-soft”--Custom variant for the inactive state. Overrides the default variant-soft behavior when isActive is false.
size”sm” | “md” | “lg""sm”, “md”, “lg""md”Size of the page number button.
iconLeftReact.ReactNodeAny React node-Icon to display on the left side of the button.
iconRightReact.ReactNodeAny React node-Icon to display on the right side of the button.
classNamestringAny CSS class string-Additional CSS classes for styling customization.

PaginationPrevious / PaginationNext

PropertyTypePossible ValuesDefaultDescription
size”sm” | “md” | “lg""sm”, “md”, “lg""md”Size of the navigation button.
disabledbooleantrue, falsefalseDisables the button when there’s no previous/next page.
classNamestringAny CSS class string-Additional CSS classes for styling customization.
childrenReact.ReactNodeAny React node”Anterior” / “Próximo”Custom label for the button.

PaginationEllipsis

PropertyTypePossible ValuesDefaultDescription
size”sm” | “md” | “lg""sm”, “md”, “lg""md”Size of the ellipsis container to match button sizes.
classNamestringAny CSS class string-Additional CSS classes for styling customization.
Last updated on