New to KendoReactStart a free 30-day trial

PagerProps

Interface

Definition

Package:@progress/kendo-react-data-tools

Properties

adaptive?

boolean

Providing different rendering of the page sizes select element based on the screen dimensions.

Specifies the text that is rendered as title in the adaptive page sizes select element.

Sets the maximum numeric buttons count before the buttons are collapsed.

Sets additional classes to the Pager.

dir?

string

Sets the direction of the component.

disabled?

boolean

Controls the disabled state of the Pager. Defaults to false.

info?

boolean

Toggles the information about the current page and the total number of records.

Useful for modifying the Pager messages.

Parameters:messageKeystringReturns:

{ messageKey: string; defaultMessage: string }

If set to true, the user can use dedicated shortcuts to interact with the Pager. By default, navigation is disabled and the Pager content is accessible in the normal tab sequence.

onPageChange?

(event: PageChangeEvent) => void | (event: BasePageChangeEvent) => void

Fires when the page of the Pager is changed. You have to handle the event yourself and page the data.

pageSizes?

number[] | string | number[]

Displays a menu for selecting the page size.

pageSizeValue?

string | number

Sets the selected value of the page size Dropdownlist. It is useful when the selected value could also be a string not only a number.

Toggles the Previous and Next buttons.

Defines if the pager will be responsive. If true, hides the tools that do not fit to the available space.

Default:

true

size?

"small" | "medium" | "large"

Configures the size of the Pager.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size className.
Default:

medium

skip

number

The number of records that will be skipped.

style?

CSSProperties

The styles that are applied to the Pager.

take

number

The number of records that will be taken.

total

number

The total number of records.

type?

"input" | "numeric"

Defines the type of the pager.

  • (Default) numeric — Renders buttons with numbers.
  • input — Renders an input field for typing the page number.