@commercetools-uikit/pagination
Version:
Components for navigating through pages of items
42 lines (41 loc) • 1.06 kB
TypeScript
import { type TPageRangeSize } from "./page-size-selector/index.js";
export type TPaginationProps = {
/**
* Total number of items across all pages
*/
totalItems: number;
/**
* The current page
*/
page: number;
/**
* A callback function, called when the page is changed.
*/
onPageChange: (newPage: number) => void;
/**
* Number of items per page, according to the pre-defined range values.
*/
perPage?: number;
/**
* Range of items per page.
* <br/>
* `xs: 5,10,15,20`
* <br/>
* `s: 20,50`
* <br/>
* `m: 20,50,100`
* <br/>
* `l: 200,500`
*/
perPageRange?: TPageRangeSize;
/**
* A callback function, called when `perPage` is changed.
*/
onPerPageChange: (newPerPage: number) => void;
};
declare const Pagination: {
({ perPage, perPageRange, ...props }: TPaginationProps): import("@emotion/react/jsx-runtime").JSX.Element;
displayName: string;
};
export type { TPageRangeSize };
export default Pagination;