React Pagination API

Pagination is a UI component that allows users to navigate through pages and change page size at runtime. Pagination UI includes a page navigator and several optional elements: a page size selector, navigation buttons, and page information.

import Pagination from "devextreme-react/pagination"
Selector: Pagination

View Demo

See Also
jQuery
Angular
Vue
React
jQuery
Angular
Vue
React

Props

An object that defines configuration properties for the Pagination UI component.

Name Description
accessKey

Specifies the shortcut key that sets focus on the UI component.
activeStateEnabled

Specifies whether the UI component changes its visual state as a result of user interaction.
allowedPageSizes

Specifies page sizes available in the page size selector.
disabled

Specifies whether the UI component responds to user interaction.
displayMode

Specifies the UI component's display mode.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
height

Specifies the UI component's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
infoText

Specifies the page information text.
itemCount

Specifies the total number of items.
label

Specifies an aria-label attribute for the pager.
onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.
onDisposing

A function that is executed before the UI component is disposed of.
onInitialized

A function used in JavaScript frameworks to save the UI component instance.
onOptionChanged

A function that is executed after a UI component property is changed.
pageIndex

Specifies the page index.
pageSize

Specifies the page size.
rtlEnabled

Switches the UI component to a right-to-left representation.
showInfo

Specifies whether to show the page information.
showNavigationButtons

Specifies whether to show navigation buttons.
showPageSizeSelector

Specifies whether to show the page size selector.
tabIndex

Specifies the number of the element when the Tab key is used for navigating.
visible

Specifies whether the UI component is visible.
width

Specifies the UI component's width.

See Also
jQuery
Angular
Vue
React

Methods

Name Description
beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the Pagination instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
focus()

Sets focus on the UI component.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
getPageCount()

Gets the number of pages.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
resetOption(optionName)

Resets a property to its default value.

Events

This section describes events fired by this UI component.

Name Description
contentReady

Raised when the UI component is rendered and each time the component is repainted.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.

See Also
jQuery
Angular
Vue
React