TableOptions_RowPagination

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

Properties

autoResetPageIndex?

optional autoResetPageIndex?: boolean;

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

If set to true, pagination will be reset to the first page when page-altering state changes e.g. data is updated, filters change, grouping changes, etc.

manualPagination?

optional manualPagination?: boolean;

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

Enables manual pagination. If this option is set to true, the table will not automatically paginate rows using getPaginatedRowModel() and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.

onPaginationChange?

optional onPaginationChange?: OnChangeFn<PaginationState>;

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

Called with an updater when pagination state changes. Pair this with state.pagination when using external state; external atoms can own the slice without this callback.

pageCount?

optional pageCount?: number;

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

When manually controlling pagination, you can supply a total pageCount value to the table if you know it (Or supply a rowCount and pageCount will be calculated). If you do not know how many pages there are, you can set this to -1.

rowCount?

optional rowCount?: number;

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

When manually controlling pagination, you can supply a total rowCount value to the table if you know it. The pageCount can be calculated from this value and the pageSize.