Pagination

The pagination feature provides methods and state for dividing table data into pages. These properties are available on the table instance when using the pagination feature. See the pagination guide for usage examples and configuration details.

Prop	Type
getCanNextPage Returns whether the table can go to the next page.	() => boolean
getCanPreviousPage Returns whether the table can go to the previous page.	() => boolean
getPageCount Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the `options.pageCount` table option, otherwise it will be calculated from the table data using the total row count and current page size.	() => number
getPageOptions Returns an array of page options (zero-index-based) for the current page size.	() => number[]
getPaginationRowModel Returns the row model for the table after pagination has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getPrePaginationRowModel Returns the row model for the table before any pagination has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
nextPage Increments the page index by one, if possible.	() => void
previousPage Decrements the page index by one, if possible.	() => void
resetPageIndex Resets the page index to its initial state. If `defaultState` is `true`, the page index will be reset to `0` regardless of initial state.	( defaultState?: boolean, ) => void
resetPageSize Resets the page size to its initial state. If `defaultState` is `true`, the page size will be reset to `10` regardless of initial state.	( defaultState?: boolean, ) => void
resetPagination Resets the `pagination` state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`.	( defaultState?: boolean, ) => void
setPageCount Updates the page count using the provided function or value.	( updater: \| T \| ((old: T) => T), ) => void
setPageIndex Updates the page index using the provided function or value in the `state.pagination.pageIndex` state.	( updater: \| T \| ((old: T) => T), ) => void
setPageSize Updates the page size using the provided function or value in the `state.pagination.pageSize` state.	( updater: \| T \| ((old: T) => T), ) => void
setPagination Sets or updates the `state.pagination` state.	( updater: \| T \| ((old: T) => T), ) => void

getCanNextPage

Type

() => boolean

Description

Returns whether the table can go to the next page.

getCanPreviousPage

Type

() => boolean

Description

Returns whether the table can go to the previous page.

getPageCount

Type

() => number

Description

Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the options.pageCount table option, otherwise it will be calculated from the table data using the total row count and current page size.

getPageOptions

Type

() => number[]

Description

Returns an array of page options (zero-index-based) for the current page size.

getPaginationRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model for the table after pagination has been applied.

getPrePaginationRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model for the table before any pagination has been applied.

Type

() => void

Description

Increments the page index by one, if possible.

Type

() => void

Description

Decrements the page index by one, if possible.

resetPageIndex

Type

(
  defaultState?: boolean,
) => void

Description

Resets the page index to its initial state. If defaultState is true, the page index will be reset to 0 regardless of initial state.

resetPageSize

Type

(
  defaultState?: boolean,
) => void

Description

Resets the page size to its initial state. If defaultState is true, the page size will be reset to 10 regardless of initial state.

resetPagination

Type

(
  defaultState?: boolean,
) => void

Description

Resets the pagination state to initialState.pagination, or true can be passed to force a default blank state reset to [].

setPageCount

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Updates the page count using the provided function or value.

setPageIndex

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Updates the page index using the provided function or value in the state.pagination.pageIndex state.

setPageSize

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Updates the page size using the provided function or value in the state.pagination.pageSize state.

setPagination

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Sets or updates the state.pagination state.

Headers

Row Expansion