SiPaginationComponent documentation¶
selector
si-pagination Input Properties¶
| Name | Type | Default | Description |
|---|---|---|---|
| backButtonText ¶ | TranslatableString | $localize`:@@SI_PAGINATION.BACK:Back` | The text of the back button for pagination. Required for a11y. |
| currentPage ¶ | number | 1 | The current active page, counting starts from 1 |
| forwardButtonText ¶ | TranslatableString | $localize`:@@SI_PAGINATION.FORWARD:Forward` | The text of the forward button for pagination. Required for a11y. |
| navAriaLabel ¶ | TranslatableString | $localize`:@@SI_PAGINATION.NAV_LABEL:Pagination` | When multiple paginations are used on the same page each pagination needs a distinct aria label. Required for a11y. |
| pageSize ¶ | number | The number of items per page. Used to calculate the total number of page if totalPages is not available | |
| totalPages ¶ | number | The total number of pages. Alternatively use itemsPerPage and totalItems | |
| totalRowCount ¶ | number | The total number of items. Used to calculate the total number of page if totalPages is not available |
Output Properties¶
| Name | Type | Description |
|---|---|---|
| currentPageChange ¶ | number | The current active page, counting starts from 1 |
Types Documentation¶
| Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality. |
|---|
Except where otherwise noted, content on this site is licensed under MIT License.