IPaginationProps

interface
Pagination

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

start
number
modelValue
number
disabled
boolean
length
number | string
totalVisible
number | string
firstIcon
TIcon
prevIcon
TIcon
nextIcon
TIcon
lastIcon
TIcon
ariaLabel
string
pageAriaLabel
string
currentPageAriaLabel
string
firstAriaLabel
string
previousAriaLabel
string
nextAriaLabel
string
lastAriaLabel
string
ellipsis
string
showFirstLastPage
boolean
compact
boolean
pageText
string
ofText
string
withInfo
boolean
Toggle the "with info" mode — pagination then renders a left-side range label `Showing {start}-{end} of {total}` next to the standard list of page buttons. Requires `total` (and optionally `perPage`) to compute meaningful start/end indices.
total
number | string
Total number of *items* (NOT pages). Drives the `withInfo` label — "Showing 21-40 of {total}". When omitted while `withInfo` is true, falls back to `length * perPage`.
perPage
number | string
Number of items rendered on a single page. Used together with `total` to compute the Showing N-M range. Defaults to 10 when `withInfo` is enabled.
infoText
string
i18n key for the `withInfo` label. Receives `{0}=start`, `{1}=end`, `{2}=total`.
previousText
string
Label rendered next to the prev chevron in `withInfo` mode. Default falls back to the `origam.pagination.previous` i18n key (`"Prev"` in English). Useful for setting a translated label inline without touching the locale catalogue.
nextText
string
Label rendered next to the next chevron in `withInfo` mode. Default falls back to the `origam.pagination.next` i18n key (`"Next"` in English).
pageNumberAriaLabel
string
aria-label for the compact mode page number `<input>`. Falls back to the `origam.pagination.ariaLabel.pageNumber` i18n key.
hoverColor
TColor
hoverBgColor
TColor
activeColor
TColor
activeBgColor
TColor