Skip to content

Interface: UsePaginationReturn\<TRow\>

Defined in: src/data/use-pagination.ts:14

Type Parameters

TRow

TRow

Properties

currentPage

currentPage: number

Defined in: src/data/use-pagination.ts:22

Current page index (0-based).


data

data: TRow[]

Defined in: src/data/use-pagination.ts:16

Current page data.


error

error: Error | null

Defined in: src/data/use-pagination.ts:20

Error from the last page load.


goToPage

goToPage: (page) => void

Defined in: src/data/use-pagination.ts:32

Navigate to a specific page.

Parameters

page

number

Returns

void


hasMore

hasMore: boolean

Defined in: src/data/use-pagination.ts:30

Whether more data is available (loadMore/infinite modes).


isLoading

isLoading: boolean

Defined in: src/data/use-pagination.ts:18

Whether a page is loading.


loadMore

loadMore: () => void

Defined in: src/data/use-pagination.ts:36

Load the next page and append (loadMore/infinite modes).

Returns

void


pageSize

pageSize: number

Defined in: src/data/use-pagination.ts:24

Current page size.


refresh

refresh: () => void

Defined in: src/data/use-pagination.ts:38

Refresh the current page.

Returns

void


setPageSize

setPageSize: (size) => void

Defined in: src/data/use-pagination.ts:34

Change the page size (resets to page 0).

Parameters

size

number

Returns

void


totalCount

totalCount: number

Defined in: src/data/use-pagination.ts:26

Total row count from the server.


totalPages

totalPages: number

Defined in: src/data/use-pagination.ts:28

Total number of pages.