Presto

usePaginator

Source
import { usePaginator } from "@prestojs/util";
usePaginator<PaginatorT,PaginatorState>(paginatorClassOrProvider,?currentStatePair)
Source

Hook to help manage paginator state. An instance of the specified paginator is created with provided state setter or a default setter if none provided. You only need to provide a state setter if you want to store the state somewhere external e.g. from URL query parameters.

See examples for CursorPaginator, PageNumberPaginator or LimitOffsetPaginator

Arguments:

ArgumentTypeDescription
*paginatorClassOrProvidernull||

Must either be an object with a getPaginatorClass method (eg. Endpoint) or a Paginator class. This class defines how pagination is handled. This value can be null in which case nothing will be returned.

currentStatePair[undefined|PaginatorState, ]

A tuple of current state and a state setter function. If not provided state is handled internally in usePaginator. You can pass useState() to this parameter.

Returns:PaginatorT|null

The paginator class instance