Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PaginationProps

Hierarchy

  • {} & {} & { ActionsComponent?: React.ElementType<TablePaginationActionsProps>; SelectProps?: Partial<SelectProps>; backIconButtonProps?: Partial<IconButtonProps>; backIconButtonText?: undefined | string; count: number; labelDisplayedRows?: undefined | ((paginationInfo: LabelDisplayedRowsArgs) => React.ReactNode); labelRowsPerPage?: React.ReactNode; nextIconButtonProps?: Partial<IconButtonProps>; nextIconButtonText?: undefined | string; onChangePage?: undefined | ((event: MouseEvent<HTMLButtonElement> | null, page: number) => void); onChangeRowsPerPage?: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement>; onPageChange: (event: MouseEvent<HTMLButtonElement> | null, page: number) => void; onRowsPerPageChange?: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement>; page: number; rowsPerPage: number; rowsPerPageOptions?: Array<number | { label: string; value: number }> }
    • PaginationProps

Index

Properties

Properties

Optional ActionsComponent

ActionsComponent: React.ElementType<TablePaginationActionsProps>

Optional SelectProps

SelectProps: Partial<SelectProps>

Optional backIconButtonProps

backIconButtonProps: Partial<IconButtonProps>

Optional backIconButtonText

backIconButtonText: undefined | string

count

count: number

Optional customClasses

customClasses: string | string[]

Custom CSS classes to pass to the button

Optional data-qa

data-qa: undefined | string

Data-qa tag to apply to the search bar and input element

Optional labelDisplayedRows

labelDisplayedRows: undefined | ((paginationInfo: LabelDisplayedRowsArgs) => React.ReactNode)

labelPaginationOf

labelPaginationOf: ReactNode

The label in the displayed pages, for example "of" in "page 1 of 10"

Optional labelRowsPerPage

labelRowsPerPage: React.ReactNode

Optional nextIconButtonProps

nextIconButtonProps: Partial<IconButtonProps>

Optional nextIconButtonText

nextIconButtonText: undefined | string

Optional onChangePage

onChangePage: undefined | ((event: MouseEvent<HTMLButtonElement> | null, page: number) => void)

Callback fired when the page is changed.

param

The event source of the callback.

param

The page selected.

deprecated

Use the onPageChange prop instead.

Optional onChangeRowsPerPage

onChangeRowsPerPage: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement>

Callback fired when the number of rows per page is changed.

param

The event source of the callback.

deprecated

Use the onRowsPerPageChange prop instead.

onPageChange

onPageChange: (event: MouseEvent<HTMLButtonElement> | null, page: number) => void

Type declaration

    • (event: MouseEvent<HTMLButtonElement> | null, page: number): void

    • Parameters

      • event: MouseEvent<HTMLButtonElement> | null
      • page: number

      Returns void

Optional onRowsPerPageChange

onRowsPerPageChange: React.ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement>

page

page: number

rowsPerPage

rowsPerPage: number

Optional rowsPerPageOptions

rowsPerPageOptions: Array<number | { label: string; value: number }>

Generated using TypeDoc