React Grid: Row Pagination
To enable pagination in, set the grid property
pagination=true. The following simple example shows this, the only difference to this and previous examples is the
Pagination does not reduce the feature set of the grid, as long as the underlying row model supports it. In other words, if you are paging over the Client-Side Row Model, all features of the Client-Side Row Model (grouping, filtering etc) are still available. Likewise for the other row models, if the row model supports it, it's available through pagination and that row model.
If you set
paginationAutoPageSize=true the grid will automatically show as many rows in each page as it can fit. This is demonstrated below. Note if you resize the display area of the grid, the page size automatically changes. To view this, open the example up in a new tab and resize your browser.
Each pagination page must have the same number of rows. If you use
getRowHeight() callback (to have different
rows with different heights) then the page height will be calculated using the default row height and not
the actual row heights. Therefore the rows will not fit perfectly into the page if these features are mixed.
In this example the default pagination settings are changed. Note the following:
paginationPageSizeis set to 10
api.paginationGoToPage(4)is called to go to page 4 (0 based, so the 5th page)
- A dropdown to change the page size dynamically is available. This makes a call to
- The numbers in the pagination panel are formatted differently using the grid callback
paginationNumberFormatterand putting the numbers into square brackets i.e. [x].
If you set
suppressPaginationPanel=true, the grid will not show the standard navigation controls for pagination. This is useful is you want to provide your own navigation controls.
In the example below you can see how this works. Note that we are listening to
onPaginationChanged to update the information about the current pagination status. We also call methods on the pagination API to change the pagination state.
A summary of the API methods and events can be found at the top of this documentation page.
The example also sets property
suppressScrollOnNewData=true, which tells the grid to NOT scroll to the top when the page changes.
Both Row Grouping and Master Detail have rows that expand. When this happens, consideration needs to be given as to how this impacts the number of rows on the page. There are two modes of operation that can be used depending on what your application requirements.
The first mode is the default. The rows are split according to the top level rows. For example if row grouping with a page size of 10, then each page will contain 10 top level groups. When expanding a group with this mode, all children for that group, along with the 10 original groups for that page, will get display in one page. This will result in a page size greater than the initial page size of 10 rows.
This mode is typically best suited for Row Grouping as children are always displayed alongside the parent group. It is also typically best for Master Detail, as detail rows (that typically contain detail tables) will always appear below their master rows.
In the example below, note the following:
- Each page will always contain exactly 10 groups.
- Expanding a group will not push rows to the next page.
The second mode paginates all rows, including child rows when Row Grouping and detail rows with Master Detail. For example if row grouping with a page size of 10, then each page will always contain exactly 10 rows, even if it means having children appear on a page after the page containing the parent. This can be particularly confusing if the last row of a page is expanded, as the children will appear on the next page (not visible to the user unless they navigate to the next page).
This modes is typically best if the application never wants to exceed the maximum number of rows in a page past the page size. This can be helpful if designing for touch devices (eg tablets) where UX requirements state no scrolls should be visible in the application - paging to a strict page size can guarantee no vertical scrolls will appear.
To enable pagination on all rows, including children, set grid property
In the example below, note the following:
- Each page will always contain exactly 10 rows (not groups).
- Expanding a group will push rows to the next page to limit the total number of rows to 10.
If using either of the following features, the grid will be forced to use the second mode:
This is because both of these features remove top level rows (group rows and master rows) from the displayed rows, making it impossible to paginate based on the top level rows only.
Set whether Pagination is enabled.
How many rows to load per page. If
The following methods compose the pagination API are all available from
Returns how many rows are being shown per page.
Returns the 0-based index of the page which is showing.
Returns the total number of pages. Returns
The total number of rows. Returns
Goes to the specified page. If the page requested doesn't exist, it will go to the last page.
Navigates to the next page.
Navigates to the previous page.
Navigates to the first page.
Navigates to the last page.
Triggered every time the paging state changes. Some of the most common scenarios for this event to be triggered are:
- Row Pagination
- Supported Row Models
- Features While Using Pagination
- Example: Auto Page Size
- Example: Customising Pagination
- Example: Custom Pagination Controls
- Pagination & Child Rows
- Mode 1: Paginate Only Top Level Rows
- Mode 2: Paginate All Rows, Including Children
- Fallback to Mode 2
- Pagination Properties
- Pagination API
- Pagination Callbacks
- Pagination Events