IPaginationProps
interface
Pagination
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- startnumber
- modelValuenumber
- disabledboolean
- lengthnumber | string
- totalVisiblenumber | string
- firstIconTIcon
- prevIconTIcon
- nextIconTIcon
- lastIconTIcon
- ariaLabelstring
- pageAriaLabelstring
- currentPageAriaLabelstring
- firstAriaLabelstring
- previousAriaLabelstring
- nextAriaLabelstring
- lastAriaLabelstring
- ellipsisstring
- showFirstLastPageboolean
- compactboolean
- pageTextstring
- ofTextstring
- withInfoboolean
- 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.
- totalnumber | 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`.
- perPagenumber | 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.
- infoTextstring
- i18n key for the `withInfo` label. Receives `{0}=start`, `{1}=end`, `{2}=total`.
- previousTextstring
- 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.
- nextTextstring
- Label rendered next to the next chevron in `withInfo` mode. Default falls back to the `origam.pagination.next` i18n key (`"Next"` in English).
- pageNumberAriaLabelstring
- aria-label for the compact mode page number `<input>`. Falls back to the `origam.pagination.ariaLabel.pageNumber` i18n key.
- hoverColorTColor
- hoverBgColorTColor
- activeColorTColor
- activeBgColorTColor