Interface ManualPaginationOptions<Data>

Type Parameters

Hierarchy

  • CommonPaginationOptions<Data>

    Hierarchy

    • ManualPaginationOptions

Custom Component Properties

Component?: PaginationComponent<Data>

Custom component to be rendered for pagination. Overrides all indicators.

firstPageIndicator?: ReactNode

Indicator/icon used in action/button to navigate to the first page.

lastPageIndicator?: ReactNode

Indicator/icon used in action/button to navigate to the last page.

nextPageIndicator?: ReactNode

Indicator/icon used in action/button to navigate to the next page.

previousPageIndicator?: ReactNode

Indicator/icon used in action/button to navigate to the previous page.

Other Properties

autoResetPage?: boolean

Reset pagination when data changes (sorting, filtering, etc.).

Default

true for client-side pagination

Default

false for manual-pagination.

disablePagination?: boolean

Disable pagination.

Default

false

fetchData: ((paginationState: UsePaginationState<Data>) => void)

Type declaration

    • (paginationState: UsePaginationState<Data>): void
    • Callback to fetch more data when manualPagination is enabled. It receives current pagination state as parameter. It should be wrapped in React.useCallback.

      Parameters

      Returns void

initialState?: Partial<UsePaginationState<Data>>

Initial settings of pagination

manualPagination?: true

Manually paginate data using external methods.

onStateChange?: StateChangeHandler<UsePaginationState<Data>>

Callback executed when page changes (all pagination changes). The function must be wrapped in useCallback hook.

pageCount: number

Number of pages available. Required for manual pagination.

pageSizes?: number[]

Show a list of page-size options in Preference panel.

Default

"[10, 20, 50, 75, 100, 150]"

paginateExpandedRows?: boolean

Count expanded sub-rows while calculating rows on a page.

Default

true

recordCount?: number

Number of total records available across all pages. If not provided, an estimation is used in the Status.

Generated using TypeDoc