UseOffsetPaginationResult
UseOffsetPaginationResult<
T> =object
Defined in: packages/pagination/src/use-offset-pagination.ts:16
Return value of the useOffsetPagination hook.
Type Parameters
Section titled “Type Parameters”T
The item type in the paginated list.
Properties
Section titled “Properties”currentPage
Section titled “currentPage”currentPage:
number
Defined in: packages/pagination/src/use-offset-pagination.ts:24
The current 1-based page number.
goToPage()
Section titled “goToPage()”goToPage: (
page) =>void
Defined in: packages/pagination/src/use-offset-pagination.ts:26
Navigates to the given 1-based page number by updating the URL search params.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
items:
T[]
Defined in: packages/pagination/src/use-offset-pagination.ts:18
Items for the current page.
total:
number
Defined in: packages/pagination/src/use-offset-pagination.ts:20
Total number of items across all pages.
totalPages
Section titled “totalPages”totalPages:
number
Defined in: packages/pagination/src/use-offset-pagination.ts:22
Total number of pages available.