Pagination

onPageChange

(page: number) => void

—

Fired with the 1-indexed target page. Not fired when the target equals the current page.

page

number

—

Current page, **1-indexed**. Clamped into range before rendering.

className

string

—

Additional CSS class name applied to the root <nav>.

hideLabel

boolean

false

Hides the Page {page} of {pageCount} label, leaving only the controls.

pageCount

number

-1

Total number of pages. Pass UNKNOWN_PAGE_COUNT (-1) or omit when the total is not known, e.g. cursor-based pagination: the label degrades to Page {page} and Next stays enabled. Total number of pages. Required — numbered pages cannot be rendered without a known total.

ref

Ref<HTMLElement>

—

Ref forwarded to the root <nav> element.

siblingCount

number

1

Not applicable to Simple; disallow usage. Page buttons rendered either side of the current page before ellipsis truncation. 1 matches the Figma spec (1 2 3 4 … 10).

type

PaginationType

PaginationType.Simple

—

Simple

"simple"

-

Previous/Next buttons. Supports an unknown total page count.

Numbered

"numbered"

-

Chevron controls plus numbered page buttons with ellipsis truncation. Requires a known pageCount.