分页 | TanStack Table Docs

状态

分页状态以以下形式存储在表格中：

tsx

export type PaginationState = {
  pageIndex: number
  pageSize: number
}

export type PaginationTableState = {
  pagination: PaginationState
}

export type PaginationInitialTableState = {
  pagination?: Partial<PaginationState>
}

表格选项

`manualPagination`

tsx

manualPagination?: boolean

启用手动分页。如果将此选项设置为true，表格将不会使用getPaginationRowModel()自动分页行，而是期望您在将行传递给表格之前手动分页。如果您正在进行服务器端分页和聚合，这将非常有用。

`pageCount`

tsx

pageCount?: number

在手动控制分页时，如果您知道总页数，请为表格提供一个总的pageCount值。如果您不知道有多少页，可以将其设置为-1。

`autoResetPageIndex`

tsx

autoResetPageIndex?: boolean

如果设置为true，当页面更改状态发生变化时，例如更新data、更改过滤器、更改分组等，分页将被重置为第一页。

🧠 注意：如果manualPagination设置为true，此选项默认为false

`onPaginationChange`

tsx

onPaginationChange?: OnChangeFn<PaginationState>

如果提供了此函数，当分页状态发生变化时，将调用该函数，并期望您自行管理状态。您可以通过tableOptions.state.pagination选项将管理的状态传递回表格。

`getPaginationRowModel`

tsx

getPaginationRowModel?: (table: Table<TData>) => () => RowModel<TData>

在分页完成后返回行模型，但不再进行进一步操作。

默认情况下，分页列会自动重新排序到列列表的开头。如果您希望删除它们或保留它们不变，请在此处设置适当的模式。

表格 API

`setPagination`

tsx

setPagination: (updater: Updater<PaginationState>) => void

设置或更新state.pagination状态。

`resetPagination`

tsx

resetPagination: (defaultState?: boolean) => void

将分页状态重置为initialState.pagination，或者可以传递true以强制将默认空状态重置为[]。

`setPageIndex`

tsx

setPageIndex: (updater: Updater<number>) => void

使用提供的函数或值更新页面索引。

`resetPageIndex`

tsx

resetPageIndex: (defaultState?: boolean) => void

将页面索引重置为初始状态。如果defaultState为true，无论初始状态如何，页面索引都将重置为0。

`setPageSize`

tsx

setPageSize: (updater: Updater<number>) => void

使用提供的函数或值更新页面大小。

`resetPageSize`

tsx

resetPageSize: (defaultState?: boolean) => void

将页面大小重置为初始状态。如果defaultState为true，无论初始状态如何，页面大小都将重置为10。

`setPageCount`

tsx

setPageCount: (updater: Updater<number>) => void

使用提供的函数或值更新页面计数。

`getPageOptions`

tsx

getPageOptions: () => number[]

返回当前页面大小的页面选项数组（从零开始索引）。

`getCanPreviousPage`

tsx

getCanPreviousPage: () => boolean

返回表格是否可以转到上一页。

`getCanNextPage`

tsx

getCanNextPage: () => boolean

返回表格是否可以转到下一页。

`previousPage`

tsx

previousPage: () => void

如果可能，将页面索引减一。

`nextPage`

tsx

nextPage: () => void

如果可能，将页面索引加一。

`getPageCount`

tsx

getPageCount: () => number

返回页面计数。如果手动分页或控制分页状态，则此值将直接来自options.pageCount表格选项，否则将使用总行数和当前页面大小从表格数据计算得出。

`getPrePaginationRowModel`

tsx

getPrePaginationRowModel: () => RowModel<TData>

返回应用任何分页之前的表格行模型。

`getPaginationRowModel`

tsx

getPaginationRowModel: () => RowModel<TData>

返回应用分页后的表格行模型。