The Grid component supports data paging. You can specify the page size and switch pages programmatically or via the Paging Panel’s UI controls. The paging state management, Paging Panel rendering, and local paging logic are implemented in the corresponding plugins. You can also configure the Grid to use server-side paging if your data service supports it.
The following plugins implement filtering features:
Note that the plugin order is important.
Import the plugins listed above to set up a Grid with basic paging.
In the uncontrolled mode, specify the initial active page index in the
In the following example, the page size is specified using the
pageSize property, which is usual for the controlled mode. However, the
onPageSizeChange event handler is not specified because page size is not supposed to be changed internally as the Page Size Selector is not available.
Assign an array of available page sizes to the
allowedPageSizes property to enable page size selection via the UI. The Page Size Selector displays the ‘All’ item if the specified array contains an item whose value is 0. You can specify custom text for this Page Size Selector item using the
The example below demonstrates the basic configuration for the uncontrolled mode. The
defaultPageSize property defines the initial page size.
In the controlled mode, specify the following
PagingState plugin property pairs to set a state value and handle its changes:
onCurrentPageChange- the currently displayed page’s index
onPageSizeChange- the page size
Note that the
onPageSizeChange handler makes sense only if the
allowedPageSizes option is specified. Otherwise, a user is not able to change the page size.
You can handle the Grid’s paging state changes to request a page data from the server according to the current page index and page size if your data service supports paging.
Paging options are updated once an end-user interacts with Paging Panel controls. Handle paging option changes using the
onPageSizeChange events and request data from the server using the applied paging options. Once the page data is received from the server, pass it to the
Note that in the case of remote paging, you do not need to use the
When you use paging features with sorting, grouping, or filtering, take a note of the order in which the plugins appear in the Grid’s container. You need to choose whether to paginate filtered rows or filter the current page. In the first case, put the
LocalFiltering plugin before the
LocalPaging one. Otherwise, inverse the plugins’ order.