Form
Pagination
Page navigation component for splitting large data sets across multiple pages.
Overview
The Pagination component lets users move through paged content (e.g. product lists or search results) with previous/next and optional page numbers. It keeps navigation consistent and accessible.
Key Business & UX Benefits
- Lets users browse large result sets without endless scrolling.
- Clear previous/next and page numbers reduce confusion.
- Accessible keyboard and focus support for all controls.
- Fits product grids, search results, and any paged content.
Pro-Tip from Larry: Use Pagination when you have many pages so users can jump to a specific page.
Usage
Pagination
Feature List
- Previous and next controls with optional page numbers
- Configurable page size and total count
- Accessible keyboard and focus support
- Theme-aligned styling for light and dark modes
API Reference
| Prop | Default | Type |
|---|---|---|
totalrequired | number | |
itemsPerPagerequired | number | |
pagerequired | number | |
siblingCount | 1 | number |
showEdges | true | boolean |
defaultPage | 1 | number |
isNavigationNumbers | boolean | |
hrefTemplate | (context: { page: number; }): stringIf set, switches Setting this will disable the internal page change handler and use the hrefTemplate to navigate to the page. The page-model will no longer be updated. | |
scrollToTop | true | booleanScroll to the top of the page when navigating to a different page. |
| Event | Type |
|---|---|
update:page | (event: "update:page", value: number): void |