@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
31 lines • 876 B
TypeScript
import * as React from 'react';
import { PaginationModel } from './types';
export declare const PaginationContext: React.Context<PaginationModel>;
export type UsePaginationModelConfig = {
/**
* The page number for the last page (it can also be used as a total page
* count)
*/
lastPage: number;
/**
* The page number for the first page
* @default 1
*/
firstPage?: number;
/**
* The initial current page
* @default 1
*/
initialCurrentPage?: number;
/**
* The function called when the page changes
*/
onPageChange?: (pageNumber: number) => void;
/**
* The size of the pagination range
* @default 5
*/
rangeSize?: number;
};
export declare const usePaginationModel: (config: UsePaginationModelConfig) => PaginationModel;
//# sourceMappingURL=usePaginationModel.d.ts.map