@public-ui/components
Version:
Contains all web components that belong to KoliBri - The accessible HTML-Standard.
26 lines (17 loc) • 5.29 kB
Markdown
# kol-pagination
<!-- Auto Generated Below -->
## Properties
| Property | Attribute | Description | Type | Default |
| -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `_boundaryCount` | `_boundary-count` | Defines the amount of pages to show next to the outer arrow buttons. | `number` \| `undefined` | `1` |
| `_customClass` | `_custom-class` | Defines the custom class attribute if _variant="custom" is set. | `string` \| `undefined` | `undefined` |
| `_hasButtons` | `_has-buttons` | Defines which navigation buttons to render (first, last, next, previous buttons). | `boolean` \| `string` \| `undefined` \| `{ first: boolean; last: boolean; next: boolean; previous: boolean; }` | `true` |
| `_label` | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` \| `undefined` | `undefined` |
| `_max` _(required)_ | `_max` | Defines the maximum number of pages. | `number` | `undefined` |
| `_on` _(required)_ | -- | Gibt an, auf welche Callback-Events reagiert werden. | `{ onChangePage?: EventValueOrEventCallback<Event, number>` \| `undefined; onChangePageSize?: EventValueOrEventCallback<Event, number>` \| `undefined; onClick?: EventValueOrEventCallback<Event, number>` \| `undefined; }` | `undefined` |
| `_page` _(required)_ | `_page` | Defines the current page. | `number` | `undefined` |
| `_pageSize` | `_page-size` | Defines the amount of entries to show per page. | `number` | `1` |
| `_pageSizeOptions` | `_page-size-options` | Defines the options for the page-size-select. | `number[]` \| `string` | `[]` |
| `_siblingCount` | `_sibling-count` | Defines the amount of pages to show next to the current page. | `number` \| `undefined` | `1` |
| `_tooltipAlign` | `_tooltip-align` | Defines where to show the Tooltip preferably: top, right, bottom or left. | `"bottom"` \| `"left"` \| `"right"` \| `"top"` \| `undefined` | `'top'` |
----------------------------------------------