Skip to main content
Version: Next

UseTablePaginationConfig

Home > @backstage/ui > UseTablePaginationConfig

Signature:

export interface UseTablePaginationConfig 

Properties

Property

Modifiers

Type

Description

defaultOffset?

number

(Optional) Default offset for uncontrolled mode

defaultPageSize?

number

(Optional) Default page size for uncontrolled mode

offset?

number

(Optional) Current offset. When provided, pagination is controlled

onNextPage?

() => void

(Optional) Callback when next page is clicked

onOffsetChange?

(offset: number) => void

(Optional) Callback when offset changes

onPageSizeChange?

(pageSize: number) => void

(Optional) Callback when page size changes

onPreviousPage?

() => void

(Optional) Callback when previous page is clicked

pageSize?

number

(Optional) Current page size. When provided, pagination is controlled

rowCount?

number

(Optional) Total number of rows in the dataset - only needed when data is not provided at the top level

showPageSizeOptions?

boolean

(Optional) Whether to show page size options