DEVELOPER REFERENCE · v4.0.0

Pagination API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

Pagination14 props1 callbacks0 methods

Pagination props
Name	Type	Description
`page`Required	`number`	Zero-based page index.
`pageCount`Required	`number`	Total number of pages available to the pagination control.
`label`Required	`string`	Label content or accessible name for the component, as rendered by this control.
`previousLabel`Required	`string`	Accessible text for moving to the previous page or period.
`nextLabel`Required	`string`	Accessible text for moving to the next page or period.
`firstLabel`Optional	`string \| undefined`	Accessible text for navigating to the first page.
`lastLabel`Optional	`string \| undefined`	Accessible text for navigating to the last page.
`variant`Optional	`"compact" \| "numbered" \| "icons" \| undefined`	Selects the visual action style without changing the action behavior.
`disabled`Optional	`boolean \| undefined`	Disables user interaction with the control.
`navigation`Optional	`boolean \| undefined`	Shows directional pagination actions.
`boundaryButtons`Optional	`boolean \| undefined`	Show first/last buttons, default false.
`buttons`Optional	`Partial<Record<PaginationDirection, false \| PaginationButtonOptions>> \| undefined`Inspect type	Per-button visibility and presentation overrides; false hides the corresponding action.
`children`Optional	`ComponentChildren`Inspect type	Optional page field/selector between the previous and next controls.
`className`Optional	`string \| undefined`	Additional CSS classes applied to the component root.

Pagination events and callbacks
Name	Type	Description
`onChange`Required	`(page: number) => void`Inspect type	Receives the new value when the user changes the control. Update the corresponding value prop for controlled use.

No component-specific imperative methods. Use props and callbacks to control this component.