New to Kendo UI for Vue? Start a free 30-day trial

Pager

Component

Represents the Kendo UI for Vue Pager component. Use the Pager to split a large set of records into pages and to move between them.

Definition

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

Properties Interface:PagerProps

Syntax:

vue
<Pager :skip="skip" :take="take" :total="total" :page-sizes="[5, 10, 20]" @pagechange="onPageChange" />

Properties

Sets the id of the element that the Pager controls, for example a Grid.

Example:
vue
<Pager :aria-controls="'products-grid'" />

Sets the maximum number of numeric buttons that the pager shows before it collapses them.

Default:

10

Example:
vue
<Pager :button-count="5" />

info?

boolean

Shows or hides the information about the current page and the total number of records.

Default:

true

Example:
vue
<Pager :info="false" />

Sets a function that returns the localization message for a message key.

Parameters:messageKeystringReturns:

{ messageKey: string; defaultMessage: string }

Fires when you change the page.

Parameters:eventanyReturns:

any

Fires when you change the page size.

Parameters:eventanyReturns:

any

Sets a custom template for the Pager content. The template receives the Pager props and the current page number.

Example:
vue
<Pager :pager-render="'pagerTemplate'" />

pageSize

number

Sets the number of records on each page.

Example:
vue
<Pager :page-size="10" />

pageSizes?

boolean | number[]

Shows a menu where you select the page size. Set it to true or to an array of page sizes.

Example:
vue
<Pager :page-sizes="[5, 10, 20]" />

pageSizeValue?

string | number

Sets the selected value of the page size DropDownList. Use it when the selected value can be a string and not only a number.

Example:
vue
<Pager :page-size-value="'All'" />

Shows or hides the Previous and Next buttons.

Example:
vue
<Pager :previous-next="true" />

Sets whether the Pager hides some of its elements when there is not enough width.

Default:

true

Example:
vue
<Pager :responsive="false" />

Sets the pager settings as one object. The values in this object override the separate pager props.

Example:
vue
<Pager :settings="{ buttonCount: 5, info: false }" />

size?

"small" | "medium" | "large"

Configures the size of the Pager.

The available options are:

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

medium

Example:
vue
<Pager :size="'small'" />

skip

number

Sets the number of records to skip.

Example:
vue
<Pager :skip="20" />

take

number

Sets the number of records to take. If you set it, the Pager uses it instead of pageSize.

Example:
vue
<Pager :take="10" />

total

number

Sets the total number of records.

Example:
vue
<Pager :total="100" />

type?

string

Sets the type of the pager. The available values are numeric and input.

Default:

'numeric'

Example:
vue
<Pager :type="'input'" />

width?

string | number

Sets the width of the Pager. A number value is in pixels.

Example:
vue
<Pager :width="'100%'" />