UNPKG

carbon-components-angular

Version:
1,199 lines (1,085 loc) 108 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>carbon-components-angular documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> <link rel="stylesheet" href="../styles/dark.css"> <style> footer.carbon { position: absolute; bottom: 0; width: 100%; z-index: 9999; } #root > div { /* * Subtracting the height of the footer to prevent * overlaying the footer ontop of content */ height: calc(100vh - 48px); } </style> </head> <body> <script> // Blocking script to avoid flickering dark mode // Dark mode toggle button var useDark = window.matchMedia('(prefers-color-scheme: dark)'); var darkModeState = useDark.matches; var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); var $darkModeToggles = document.querySelectorAll('.dark-mode-switch'); var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state'); function checkToggle(check) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].checked = check; } } function toggleDarkMode(state) { if (window.localStorage) { localStorage.setItem('compodoc_darkmode-state', state); } checkToggle(state); const hasClass = document.body.classList.contains('dark'); if (state) { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.add('dark'); } if (!hasClass) { document.body.classList.add('dark'); } } else { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.remove('dark'); } if (hasClass) { document.body.classList.remove('dark'); } } } useDark.addEventListener('change', function (evt) { toggleDarkMode(evt.matches); }); if (darkModeStateLocal) { darkModeState = darkModeStateLocal === 'true'; } toggleDarkMode(darkModeState); </script> <div class="navbar navbar-default navbar-fixed-top d-md-none p-0"> <div class="d-flex"> <a href="../" class="navbar-brand">carbon-components-angular documentation</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="d-none d-md-block menu"> <compodoc-menu mode="normal"></compodoc-menu> </div> <!-- START CONTENT --> <div class="content component"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Components</li> <li class="breadcrumb-item" > Pagination</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" class="nav-link active" role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a> </li> <li class="nav-item"> <a href="#source" class="nav-link" role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a> </li> <li class="nav-item"> <a href="#tree" class="nav-link" role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="info"><p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/pagination/pagination.component.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>Use pagination when you have multiple pages of data to handle. Get started with importing the module:</p> <b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">import { PaginationModule } from &#39;carbon-components-angular&#39;;</code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-html"> &lt;cds-pagination [model]=&quot;model&quot; (selectPage)=&quot;selectPage($event)&quot;&gt;&lt;/cds-pagination&gt;</code></pre></div><p>In your <code>selectPage()</code> method set the <code>model.currentPage</code> to selected page, <em>after</em> you load the page.</p> <b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">selectPage(page) { // ... your code to load the page goes here this.model.currentPage = page; // ... anything you want to do after page selection changes goes here }</code></pre></div><p><a href="../../?path=/story/components-pagination--basic">See demo</a></p> </p> <section data-compodoc="block-metadata"> <h3>Metadata</h3> <table class="table table-sm table-hover metadata"> <tbody> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>cds-pagination, ibm-pagination</code></td> </tr> <tr> <td class="col-md-3">template</td> <td class="col-md-9"><pre class="line-numbers"><code class="language-html">&lt;div class&#x3D;&quot;cds--pagination&quot; [ngClass]&#x3D;&quot;{ &#x27;cds--skeleton&#x27;: skeleton }&quot;&gt; &lt;!-- left skeleton div --&gt; &lt;div *ngIf&#x3D;&quot;skeleton&quot; class&#x3D;&quot;cds--pagination__left&quot;&gt; &lt;p class&#x3D;&quot;cds--skeleton__text&quot; style&#x3D;&quot;width: 70px&quot;&gt;&lt;/p&gt; &lt;p class&#x3D;&quot;cds--skeleton__text&quot; style&#x3D;&quot;width: 35px&quot;&gt;&lt;/p&gt; &lt;p class&#x3D;&quot;cds--skeleton__text&quot; style&#x3D;&quot;width: 105px&quot;&gt;&lt;/p&gt; &lt;/div&gt; &lt;div *ngIf&#x3D;&quot;!skeleton&quot; class&#x3D;&quot;cds--pagination__left&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;showPageInput&quot;&gt; &lt;label class&#x3D;&quot;cds--pagination__text&quot; [for]&#x3D;&quot;itemsPerPageSelectId&quot;&gt; {{itemsPerPageText.subject | async}} &lt;/label&gt; &lt;div class&#x3D;&quot;cds--select cds--select--inline cds--select__item-count&quot; [class.cds--select--disabled]&#x3D;&quot;pageInputDisabled&quot;&gt; &lt;select [id]&#x3D;&quot;itemsPerPageSelectId&quot; [(ngModel)]&#x3D;&quot;itemsPerPage&quot; [disabled]&#x3D;&quot;pageInputDisabled&quot; class&#x3D;&quot;cds--select-input&quot;&gt; &lt;option class&#x3D;&quot;cds--select-option&quot; *ngFor&#x3D;&quot;let option of itemsPerPageOptions&quot; [value]&#x3D;&quot;option&quot;&gt; {{ option }} &lt;/option&gt; &lt;/select&gt; &lt;svg cdsIcon&#x3D;&quot;chevron--down&quot; size&#x3D;&quot;16&quot; style&#x3D;&quot;display: inherit&quot; class&#x3D;&quot;cds--select__arrow&quot; aria-hidden&#x3D;&quot;true&quot; [attr.ariaLabel]&#x3D;&quot;optionsListText.subject | async&quot;&gt; &lt;/svg&gt; &lt;/div&gt; &lt;/ng-container&gt; &lt;span *ngIf&#x3D;&quot;!pagesUnknown &amp;&amp; totalDataLength &lt;&#x3D; 1&quot; class&#x3D;&quot;cds--pagination__text cds--pagination__items-count&quot; [ngStyle]&#x3D;&quot;{&#x27;margin-left&#x27;: showPageInput ? null : 0}&quot;&gt; {{totalItemText.subject | i18nReplace:{start: startItemIndex, end: endItemIndex, total: totalDataLength } | async}} &lt;/span&gt; &lt;span *ngIf&#x3D;&quot;!pagesUnknown &amp;&amp; totalDataLength &gt; 1&quot; class&#x3D;&quot;cds--pagination__text cds--pagination__items-count&quot; [ngStyle]&#x3D;&quot;{&#x27;margin-left&#x27;: showPageInput ? null : 0}&quot;&gt; {{totalItemsText.subject | i18nReplace:{start: startItemIndex, end: endItemIndex, total: totalDataLength } | async}} &lt;/span&gt; &lt;span *ngIf&#x3D;&quot;pagesUnknown&quot; class&#x3D;&quot;cds--pagination__text cds--pagination__items-count&quot; [ngStyle]&#x3D;&quot;{&#x27;margin-left&#x27;: showPageInput ? null : 0}&quot;&gt; {{totalItemsUnknownText.subject | i18nReplace:{start: startItemIndex, end: endItemIndex } | async}} &lt;/span&gt; &lt;/div&gt; &lt;!-- right skeleton div --&gt; &lt;div *ngIf&#x3D;&quot;skeleton&quot; class&#x3D;&quot;cds--pagination__right&quot;&gt; &lt;p class&#x3D;&quot;cds--skeleton__text&quot; style&#x3D;&quot;width: 70px&quot;&gt;&lt;/p&gt; &lt;/div&gt; &lt;div *ngIf&#x3D;&quot;!skeleton&quot; class&#x3D;&quot;cds--pagination__right&quot;&gt; &lt;span *ngIf&#x3D;&quot;pagesUnknown&quot; class&#x3D;&quot;cds--pagination__text cds--pagination__page-text&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!showPageInput&quot;&gt;{{currentPage}}&lt;/ng-container&gt; {{pageText.subject | async}} &lt;/span&gt; &lt;ng-container *ngIf&#x3D;&quot;showPageInput&quot;&gt; &lt;div class&#x3D;&quot;cds--select cds--select--inline cds--select__page-number&quot; [class.cds--select--disabled]&#x3D;&quot;pageInputDisabled&quot;&gt; &lt;label [for]&#x3D;&quot;currentPageSelectId&quot; class&#x3D;&quot;cds--label cds--visually-hidden&quot;&gt;{{pageText.subject | async}}&lt;/label&gt; &lt;input *ngIf&#x3D;&quot;pageOptions.length &gt; pageSelectThreshold&quot; style&#x3D;&quot;padding-right: 1rem; margin-right: 1rem;&quot; [id]&#x3D;&quot;currentPageSelectId&quot; type&#x3D;&quot;number&quot; min&#x3D;&quot;1&quot; [max]&#x3D;&quot;pageOptions.length&quot; class&#x3D;&quot;cds--select-input&quot; [(ngModel)]&#x3D;&quot;currentPage&quot;&gt; &lt;select *ngIf&#x3D;&quot;pageOptions.length &lt;&#x3D; pageSelectThreshold&quot; [id]&#x3D;&quot;currentPageSelectId&quot; class&#x3D;&quot;cds--select-input&quot; [disabled]&#x3D;&quot;pageInputDisabled&quot; [(ngModel)]&#x3D;&quot;currentPage&quot;&gt; &lt;option *ngFor&#x3D;&quot;let page of pageOptions; let i &#x3D; index;&quot; class&#x3D;&quot;cds--select-option&quot; [value]&#x3D;&quot;i + 1&quot;&gt;{{i + 1}}&lt;/option&gt; &lt;/select&gt; &lt;svg *ngIf&#x3D;&quot;pageOptions.length &lt;&#x3D; pageSelectThreshold&quot; cdsIcon&#x3D;&quot;chevron--down&quot; size&#x3D;&quot;16&quot; style&#x3D;&quot;display: inherit;&quot; class&#x3D;&quot;cds--select__arrow&quot; [attr.ariaLabel]&#x3D;&quot;optionsListText.subject | async&quot;&gt; &lt;/svg&gt; &lt;/div&gt; &lt;/ng-container&gt; &lt;span *ngIf&#x3D;&quot;!pagesUnknown &amp;&amp; lastPage &lt;&#x3D; 1&quot; class&#x3D;&quot;cds--pagination__text&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!showPageInput&quot;&gt;{{currentPage}}&lt;/ng-container&gt; {{ofLastPageText.subject | i18nReplace: {last: lastPage} | async}} &lt;/span&gt; &lt;span *ngIf&#x3D;&quot;!pagesUnknown &amp;&amp; lastPage &gt; 1&quot; class&#x3D;&quot;cds--pagination__text&quot;&gt; &lt;ng-container *ngIf&#x3D;&quot;!showPageInput&quot;&gt;{{currentPage}}&lt;/ng-container&gt; {{ofLastPagesText.subject | i18nReplace: {last: lastPage} | async}} &lt;/span&gt; &lt;div class&#x3D;&quot;cds--pagination__control-buttons&quot;&gt; &lt;button cdsButton&#x3D;&quot;ghost&quot; iconOnly&#x3D;&quot;true&quot; class&#x3D;&quot;cds--pagination__button cds--pagination__button--backward&quot; [ngClass]&#x3D;&quot;{ &#x27;cds--pagination__button--no-index&#x27;: currentPage &lt;&#x3D; 1 || disabled }&quot; tabindex&#x3D;&quot;0&quot; [attr.aria-label]&#x3D;&quot;backwardText.subject | async&quot; (click)&#x3D;&quot;selectPage.emit(previousPage)&quot; [disabled]&#x3D;&quot;(currentPage &lt;&#x3D; 1 || disabled ? true : null)&quot;&gt; &lt;svg cdsIcon&#x3D;&quot;caret--left&quot; size&#x3D;&quot;16&quot; class&#x3D;&quot;cds--btn__icon&quot;&gt;&lt;/svg&gt; &lt;/button&gt; &lt;button cdsButton&#x3D;&quot;ghost&quot; iconOnly&#x3D;&quot;true&quot; class&#x3D;&quot; cds--pagination__button cds--pagination__button--forward&quot; [ngClass]&#x3D;&quot;{ &#x27;cds--pagination__button--no-index&#x27;: currentPage &gt;&#x3D; lastPage || disabled }&quot; tabindex&#x3D;&quot;0&quot; [attr.aria-label]&#x3D;&quot;forwardText.subject | async&quot; (click)&#x3D;&quot;selectPage.emit(nextPage)&quot; [disabled]&#x3D;&quot;(currentPage &gt;&#x3D; lastPage || disabled ? true : null)&quot;&gt; &lt;svg cdsIcon&#x3D;&quot;caret--right&quot; size&#x3D;&quot;16&quot; class&#x3D;&quot;cds--btn__icon&quot;&gt;&lt;/svg&gt; &lt;/button&gt; &lt;/div&gt; &lt;/div&gt; &lt;/div&gt; </code></pre></td> </tr> </tbody> </table> </section> <section data-compodoc="block-index"> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Protected</span> <a href="#_pageOptions" >_pageOptions</a> </li> <li> <a href="#backwardText" >backwardText</a> </li> <li> <a href="#currentPageSelectId" >currentPageSelectId</a> </li> <li> <a href="#forwardText" >forwardText</a> </li> <li> <a href="#itemsPerPageSelectId" >itemsPerPageSelectId</a> </li> <li> <a href="#itemsPerPageText" >itemsPerPageText</a> </li> <li> <a href="#ofLastPagesText" >ofLastPagesText</a> </li> <li> <a href="#ofLastPageText" >ofLastPageText</a> </li> <li> <a href="#optionsListText" >optionsListText</a> </li> <li> <a href="#pageText" >pageText</a> </li> <li> <span class="modifier">Static</span> <a href="#paginationCounter" >paginationCounter</a> </li> <li> <a href="#totalItemsText" >totalItemsText</a> </li> <li> <a href="#totalItemsUnknownText" >totalItemsUnknownText</a> </li> <li> <a href="#totalItemText" >totalItemText</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Inputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#disabled" >disabled</a> </li> <li> <a href="#itemsPerPageOptions" >itemsPerPageOptions</a> </li> <li> <a href="#model" >model</a> </li> <li> <a href="#pageInputDisabled" >pageInputDisabled</a> </li> <li> <a href="#pageSelectThreshold" >pageSelectThreshold</a> </li> <li> <a href="#pagesUnknown" >pagesUnknown</a> </li> <li> <a href="#showPageInput" >showPageInput</a> </li> <li> <a href="#skeleton" >skeleton</a> </li> <li> <a href="#translations" >translations</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Outputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#selectPage" >selectPage</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Accessors</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#translations" >translations</a> </li> <li> <a href="#itemsPerPage" >itemsPerPage</a> </li> <li> <a href="#currentPage" >currentPage</a> </li> <li> <a href="#totalDataLength" >totalDataLength</a> </li> <li> <a href="#lastPage" >lastPage</a> </li> <li> <a href="#startItemIndex" >startItemIndex</a> </li> <li> <a href="#endItemIndex" >endItemIndex</a> </li> <li> <a href="#previousPage" >previousPage</a> </li> <li> <a href="#nextPage" >nextPage</a> </li> <li> <a href="#pageOptions" >pageOptions</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-constructor"> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor(i18n: <a href="../injectables/I18n.html" target="_self">I18n</a>, experimental: <a href="../injectables/ExperimentalService.html" target="_self">ExperimentalService</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="349" class="link-to-prism">src/pagination/pagination.component.ts:349</a></div> </td> </tr> <tr> <td class="col-md-4"> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>i18n</td> <td> <code><a href="../injectables/I18n.html" target="_self" >I18n</a></code> </td> <td> No </td> </tr> <tr> <td>experimental</td> <td> <code><a href="../injectables/ExperimentalService.html" target="_self" >ExperimentalService</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-inputs"> <h3 id="inputs">Inputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="disabled"></a> <b>disabled</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="207" class="link-to-prism">src/pagination/pagination.component.ts:207</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> to disable the backward/forward buttons.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="itemsPerPageOptions"></a> <b>itemsPerPageOptions</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>number[]</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>[10, 20, 30, 40, 50]</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="258" class="link-to-prism">src/pagination/pagination.component.ts:258</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Options for items per page select</p> <p>A default array of options will be defined: [10, 20, 30, 40, 50]</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="model"></a> <b>model</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../classes/PaginationModel.html" target="_self" >PaginationModel</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="203" class="link-to-prism">src/pagination/pagination.component.ts:203</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p><code>PaginationModel</code> with the information about pages you&#39;re controlling.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="pageInputDisabled"></a> <b>pageInputDisabled</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="211" class="link-to-prism">src/pagination/pagination.component.ts:211</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> to disable the select box that changes the page.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="pageSelectThreshold"></a> <b>pageSelectThreshold</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>1000</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="220" class="link-to-prism">src/pagination/pagination.component.ts:220</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="pagesUnknown"></a> <b>pagesUnknown</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="219" class="link-to-prism">src/pagination/pagination.component.ts:219</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> if the total number of items is unknown.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="showPageInput"></a> <b>showPageInput</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>true</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="215" class="link-to-prism">src/pagination/pagination.component.ts:215</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Controls wether or not to show the page selects</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="skeleton"></a> <b>skeleton</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="199" class="link-to-prism">src/pagination/pagination.component.ts:199</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Set to <code>true</code> for a loading pagination component.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="translations"></a> <b>translations</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../interfaces/PaginationTranslations.html" target="_self" >PaginationTranslations</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="239" class="link-to-prism">src/pagination/pagination.component.ts:239</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Expects an object that contains some or all of:</p> <b>Example :</b><div><pre class="line-numbers"><code class="language-none">{ &quot;ITEMS_PER_PAGE&quot;: &quot;Items per page:&quot;, &quot;OPEN_LIST_OF_OPTIONS&quot;: &quot;Open list of options&quot;, &quot;BACKWARD&quot;: &quot;Backward&quot;, &quot;FORWARD&quot;: &quot;Forward&quot;, &quot;TOTAL_ITEMS_UNKNOWN&quot;: &quot;{{start}}-{{end}} items&quot;, &quot;TOTAL_ITEMS&quot;: &quot;{{start}}-{{end}} of {{total}} items&quot;, &quot;TOTAL_ITEM&quot;: &quot;{{start}}-{{end}} of {{total}} item&quot;, &quot;OF_LAST_PAGES&quot;: &quot;of {{last}} pages&quot;, &quot;OF_LAST_PAGE&quot;: &quot;of {{last}} page&quot; }</code></pre></div></div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-outputs"> <h3 id="outputs">Outputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="selectPage"></a> <b>selectPage</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="266" class="link-to-prism">src/pagination/pagination.component.ts:266</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits the new page number.</p> <p>You should tie into this and update <code>model.currentPage</code> once the fresh data is finally loaded.</p> </div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-properties"> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="_pageOptions"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>_pageOptions</b></span> <a href="#_pageOptions"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>[]</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>[]</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="349" class="link-to-prism">src/pagination/pagination.component.ts:349</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="backwardText"></a> <span class="name"> <span ><b>backwardText</b></span> <a href="#backwardText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.BACKWARD&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="340" class="link-to-prism">src/pagination/pagination.component.ts:340</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="currentPageSelectId"></a> <span class="name"> <span ><b>currentPageSelectId</b></span> <a href="#currentPageSelectId"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>&#x60;pagination-select-current-page-${Pagination.paginationCounter}&#x60;</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="336" class="link-to-prism">src/pagination/pagination.component.ts:336</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="forwardText"></a> <span class="name"> <span ><b>forwardText</b></span> <a href="#forwardText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.FORWARD&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="341" class="link-to-prism">src/pagination/pagination.component.ts:341</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="itemsPerPageSelectId"></a> <span class="name"> <span ><b>itemsPerPageSelectId</b></span> <a href="#itemsPerPageSelectId"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>&#x60;pagination-select-items-per-page-${Pagination.paginationCounter}&#x60;</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="335" class="link-to-prism">src/pagination/pagination.component.ts:335</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="itemsPerPageText"></a> <span class="name"> <span ><b>itemsPerPageText</b></span> <a href="#itemsPerPageText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.ITEMS_PER_PAGE&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="338" class="link-to-prism">src/pagination/pagination.component.ts:338</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="ofLastPagesText"></a> <span class="name"> <span ><b>ofLastPagesText</b></span> <a href="#ofLastPagesText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.OF_LAST_PAGES&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="346" class="link-to-prism">src/pagination/pagination.component.ts:346</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="ofLastPageText"></a> <span class="name"> <span ><b>ofLastPageText</b></span> <a href="#ofLastPageText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.OF_LAST_PAGE&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="347" class="link-to-prism">src/pagination/pagination.component.ts:347</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="optionsListText"></a> <span class="name"> <span ><b>optionsListText</b></span> <a href="#optionsListText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.OPEN_LIST_OF_OPTIONS&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="339" class="link-to-prism">src/pagination/pagination.component.ts:339</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="pageText"></a> <span class="name"> <span ><b>pageText</b></span> <a href="#pageText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.PAGE&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="345" class="link-to-prism">src/pagination/pagination.component.ts:345</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="paginationCounter"></a> <span class="name"> <span class="modifier">Static</span> <span ><b>paginationCounter</b></span> <a href="#paginationCounter"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>0</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="194" class="link-to-prism">src/pagination/pagination.component.ts:194</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="totalItemsText"></a> <span class="name"> <span ><b>totalItemsText</b></span> <a href="#totalItemsText"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;PAGINATION.TOTAL_ITEMS&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="342" class="link-to-prism">src/pagination/pagination.component.ts:342</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody>