copy | PaginationNumberedCopy | PaginationCopy | — | Copy for the landmark, the steps, the status and the page buttons.
Copy for the landmark, the steps and the status. |
className | string | — | Classes appended to the landmark. |
defaultPage | number | 1 | Initial one-based page when uncontrolled. |
hideLabel | boolean | — | Hides the status line. The same text stays available to screen readers as a polite status. |
loading | boolean | false | A page is loading. The landmark reports aria-busy and data-loading, and a press asks for nothing until
loading ends. The controls stay focusable and keep their paint: loading is not disabled. |
locale | string | — | BCP 47 locale that formats the digits on the page buttons. Defaults to the runtime locale.
Belongs to the Numbered form. |
onPageChange | ((page: number, details: ChangeDetails<ChangeReason.ItemPress>) => void) | — | Called when a press asks for another page, including in controlled mode, and not when the target is the page
already shown. Cancel the change through details to keep the current page. The component never fetches: the
caller loads the page.
@param page - The one-based page that was asked for
@param details - Why the change was asked for, the press event, and the pressed control |
page | number | — | Controlled one-based page. undefined on the first render makes the component uncontrolled. A page outside
1 through pageCount is shown clamped into range, and onPageChange is not called for the clamp. |
pageCount | number | UNKNOWN_PAGE_COUNT | Total pages. Required: page buttons cannot be drawn without a known total.
Total pages. Omit it, or pass UNKNOWN_PAGE_COUNT (-1), when the total is not known, as with cursor
pagination: the status reads copy.page, and Next stays enabled. A negative, fractional or non-finite count
is treated the same way: a fraction is rounded down and the rest count as unknown. |
ref | Ref<HTMLElement> | — | Ref to the nav landmark. |
showArrows | boolean | true | Belongs to the Simple form.
Draws a chevron beside each step label. The chevrons mirror in right-to-left text. |
siblingCount | number | 1 | Page buttons shown on each side of the current page before the list truncates. 1 gives 1 … 4 5 6 … 10.
Belongs to the Numbered form. |
type | PaginationType | PaginationType.Simple | The form to render. |