Table_RowPagination

Defined in: features/row-pagination/rowPaginationFeature.types.ts:47

Type Parameters

_TFeatures

_TFeatures extends TableFeatures

_TData

_TData extends RowData

Properties

autoResetPageIndex

autoResetPageIndex: () => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:58

Resets the page index to 0 after page-altering changes such as new data, filtering, sorting, or grouping.

Honors autoResetAll, autoResetPageIndex, and manualPagination. Called by the row models; you rarely need to invoke it yourself.

Returns

void

firstPage

firstPage: () => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:97

Sets the page index to 0.

Returns

void

getCanLastPage

getCanLastPage: () => boolean;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:66

Checks whether a known, finite last page exists after the current page.

Returns

boolean

getCanNextPage

getCanNextPage: () => boolean;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:62

Checks whether the current page index can move forward.

Returns

boolean

getCanPreviousPage

getCanPreviousPage: () => boolean;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:70

Checks whether the current page index can move backward.

Returns

boolean

getPageCount

getPageCount: () => number;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:75

Resolves the current page count from options.pageCount or row count and page size.

Returns

number

getPageOptions

getPageOptions: () => number[];

Defined in: features/row-pagination/rowPaginationFeature.types.ts:85

Builds zero-based page indexes for the current page count.

Returns

number[]

getRowCount

getRowCount: () => number;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:81

Resolves the row count used for pagination math.

options.rowCount wins; otherwise the pre-paginated row model is counted.

Returns

number

lastPage

lastPage: () => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:102

Sets the page index to the last known page. Does nothing when the page count is unknown, empty, or non-finite.

Returns

void

nextPage

nextPage: () => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:89

Increments the page index by one, if possible.

Returns

void

previousPage

previousPage: () => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:93

Decrements the page index by one, if possible.

Returns

void

resetPageIndex

resetPageIndex: (defaultState?) => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:107

Resets pagination.pageIndex to initial state, or to 0 when defaultState is true.

Parameters

defaultState?

boolean

Returns

void

resetPageSize

resetPageSize: (defaultState?) => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:112

Resets pagination.pageSize to initial state, or to 10 when defaultState is true.

Parameters

defaultState?

boolean

Returns

void

resetPagination

resetPagination: (defaultState?) => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:119

Resets pagination to initialState.pagination.

Pass true to ignore initial state and reset to { pageIndex: 0, pageSize: 10 }.

Parameters

defaultState?

boolean

Returns

void

setPageIndex

setPageIndex: (updater) => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:123

Updates pagination.pageIndex using a value or updater.

Parameters

updater

Updater<number>

Returns

void

setPageSize

setPageSize: (updater) => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:127

Updates pagination.pageSize using a value or updater.

Parameters

updater

Updater<number>

Returns

void

setPagination

setPagination: (updater) => void;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:131

Updates pagination state with a next state or updater function.

Parameters

updater

Updater<PaginationState>

Returns

void