Partial pagination

[fzaninotto]

Problem

The getList() and getManyReference() methods return paginated responses. Sometimes, executing a "count" server-side to return the total number of records is expensive.

Solution

In this case, you can omit the total property in the response, and pass a pageInfo object instead, specifying if there are previous and next pages:

dataProvider.getList('comments', {
    pagination: { page: 1, perPage: 6 },
    sort: { field: 'created_at', order: 'DESC' },
})
.then(response => console.log(response));
// {
//     data: [
//         { id: 126, body: "allo?", author_id: 12 },
//         { id: 127, body: "bien le bonjour", author_id: 12 },
//         { id: 124, body: "good day sunshine", author_id: 45 },
//         { id: 123, body: "hello, world", author_id: 67 },
//         { id: 125, body: "howdy partner", author_id: 89 },
//         { id: 138, body: "nice sweater!", author_id: 78 },
//     ],
//     pageInfo: {
//         hasPreviousPage: false,    
//         hasNextPage: true,
//     }
// }

React-admin's <Pagination> component will automatically handle the pageInfo object and display the appropriate pagination controls.

Enregistrement.de.l.ecran.2022-01-26.a.07.59.25.mov

And while we are at it, time to upgrade to the new MUI <Pagination> component!

mui-pagination.mov

• add pageInfo in the response signature for getList and getManyReference
• add support for pageInfo in useGetList
• add support for pageInfo in useGetManyReference
• add support for pageInfo in useListController
• add support for pageInfo in useList
• add support for pageInfo in useReferenceManyFieldController
• add support for pageInfo in useReferenceInputController
• add support for pageInfo in useReferenceArrayInputController
• Add new component to render Pagination controls for partial pagination
• Migrate the <PaginationActions> to the new MUI <Pagination> component
• Add tests
• Add documentation

Closes #6300 and #5003

[WiXSL]

BC spotted: You change prev for previous.

Update: Now I see that, technically, it wasn't being used

[fzaninotto]

indeed, I need to add an entry to the Upgrade guide

[WiXSL]

e2e test failing

[djhi]

Few linter warnings left, otherwise 💪