UNPKG

783 BTypeScriptView Raw
1export interface PaginationInstance {
2 /**
3 * An optional ID for the pagination instance. Only useful if you wish to
4 * have more than once instance at a time in a given component.
5 */
6 id?: string;
7 /**
8 * The number of items per paginated page.
9 */
10 itemsPerPage: number;
11 /**
12 * The current (active) page.
13 */
14 currentPage: number;
15 /**
16 * The total number of items in the collection. Only useful when
17 * doing server-side paging, where the collection size is limited
18 * to a single page returned by the server API.
19 *
20 * For in-memory paging, this property should not be set, as it
21 * will be automatically set to the value of collection.length.
22 */
23 totalItems?: number;
24}