Page Navigation Methods

nextPage()

nextPage(): number | null

Returns the next page number, or null if already on the last page.

prevPage()

prevPage(): number | null

Returns the previous page number, or null if already on the first page.

isFirstPage()

isFirstPage(): boolean

Returns whether the current page is the first page.

isLastPage()

isLastPage(): boolean

Returns whether the current page is the last page.

hasPrevPage()

hasPrevPage(): boolean

Returns whether a previous page exists.

hasNextPage()

hasNextPage(): boolean

Returns whether a next page exists.

firstPage()

firstPage(): number

Returns the first page number (always 1).

lastPage()

lastPage(): number

Returns the last page number.

pageList()

pageList(options?: PageListOptions): number[]

Generates an array of page numbers for UI display.

Parameters

interface PageListOptions {
  edgeCount?: number; // default: 1
  siblingCount?: number; // default: 1
}

Behavior

• Always shows first/last edgeCount pages.
• Shows siblingCount pages around current page.
• Merges overlapping ranges.

Example