stupa-pdf-api/frontend/node_modules/@mui/x-data-grid/hooks/features/pagination/gridPaginationInterfaces.d.ts

45 lines
1.4 KiB
TypeScript

import { GridPaginationModel } from '../../../models/gridPaginationProps';
export interface GridPaginationState {
paginationModel: GridPaginationModel;
rowCount: number;
}
export interface GridPaginationInitialState {
paginationModel?: Partial<GridPaginationModel>;
rowCount?: number;
}
/**
* The pagination model API interface that is available in the grid `apiRef`.
*/
export interface GridPaginationModelApi {
/**
* Sets the displayed page to the value given by `page`.
* @param {number} page The new page number.
*/
setPage: (page: number) => void;
/**
* Sets the number of displayed rows to the value given by `pageSize`.
* @param {number} pageSize The new number of displayed rows.
*/
setPageSize: (pageSize: number) => void;
/**
* Sets the `paginationModel` to a new value.
* @param {GridPaginationModel} model The new model value.
*/
setPaginationModel: (model: GridPaginationModel) => void;
}
/**
* The pagination row count API interface that is available in the grid `apiRef`.
*/
export interface GridPaginationRowCountApi {
/**
* Sets the `rowCount` to a new value.
* @param {number} rowCount The new row count value.
*/
setRowCount: (rowCount: number) => void;
}
/**
* The pagination API interface that is available in the grid `apiRef`.
*/
export interface GridPaginationApi extends GridPaginationModelApi, GridPaginationRowCountApi {
}