carbon-components-angular
Version:
Next generation components
557 lines (492 loc) • 24.7 kB
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 module">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Modules</li>
<li class="breadcrumb-item" >PaginationModule</li>
</ol>
<div class="text-center module-graph-container">
<div id="module-graph-svg">
<!-- Generated by graphviz version 2.47.0 (20210316.0004)
-->
<!-- Title: dependencies Pages: 1 -->
<svg width="1020pt" height="284pt"
viewBox="0.00 0.00 1020.00 284.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 280)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-280 1016,-280 1016,4 -4,4"/>
<text text-anchor="start" x="485.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="272,-10 272,-30 292,-30 292,-10 272,-10"/>
<text text-anchor="start" x="295.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="385,-10 385,-30 405,-30 405,-10 385,-10"/>
<text text-anchor="start" x="408.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="471,-10 471,-30 491,-30 491,-10 471,-10"/>
<text text-anchor="start" x="494.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="568,-10 568,-30 588,-30 588,-10 568,-10"/>
<text text-anchor="start" x="591.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="664,-10 664,-30 684,-30 684,-10 664,-10"/>
<text text-anchor="start" x="687.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_PaginationModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-268 1004,-268 1004,-70 8,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_PaginationModule_declarations</title>
<polygon fill="none" stroke="black" points="496,-78 496,-130 996,-130 996,-78 496,-78"/>
</g>
<g id="clust8" class="cluster">
<title>cluster_PaginationModule_exports</title>
<polygon fill="none" stroke="black" points="209,-208 209,-260 724,-260 724,-208 209,-208"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_PaginationModule_imports</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 488,-130 488,-78 16,-78"/>
</g>
<!-- Pagination -->
<g id="node1" class="node">
<title>Pagination</title>
<polygon fill="#ffffb3" stroke="black" points="987.88,-122 912.12,-122 912.12,-86 987.88,-86 987.88,-122"/>
<text text-anchor="middle" x="950" y="-99.8" font-family="Times,serif" font-size="14.00">Pagination</text>
</g>
<!-- PaginationModule -->
<g id="node5" class="node">
<title>PaginationModule</title>
<polygon fill="#8dd3c7" stroke="black" points="559.93,-187 556.93,-191 535.93,-191 532.93,-187 440.07,-187 440.07,-151 559.93,-151 559.93,-187"/>
<text text-anchor="middle" x="500" y="-164.8" font-family="Times,serif" font-size="14.00">PaginationModule</text>
</g>
<!-- Pagination->PaginationModule -->
<g id="edge1" class="edge">
<title>Pagination->PaginationModule</title>
<path fill="none" stroke="black" d="M950,-122.13C950,-142.57 950,-173 950,-173 950,-173 569.76,-173 569.76,-173"/>
<polygon fill="black" stroke="black" points="569.76,-169.5 559.76,-173 569.76,-176.5 569.76,-169.5"/>
</g>
<!-- PaginationNav -->
<g id="node2" class="node">
<title>PaginationNav</title>
<polygon fill="#ffffb3" stroke="black" points="893.71,-122 794.29,-122 794.29,-86 893.71,-86 893.71,-122"/>
<text text-anchor="middle" x="844" y="-99.8" font-family="Times,serif" font-size="14.00">PaginationNav</text>
</g>
<!-- PaginationNav->PaginationModule -->
<g id="edge2" class="edge">
<title>PaginationNav->PaginationModule</title>
<path fill="none" stroke="black" d="M844,-122.27C844,-140.56 844,-166 844,-166 844,-166 569.92,-166 569.92,-166"/>
<polygon fill="black" stroke="black" points="569.92,-162.5 559.92,-166 569.92,-169.5 569.92,-162.5"/>
</g>
<!-- PaginationNavItem -->
<g id="node3" class="node">
<title>PaginationNavItem</title>
<polygon fill="#ffffb3" stroke="black" points="776.36,-122 651.64,-122 651.64,-86 776.36,-86 776.36,-122"/>
<text text-anchor="middle" x="714" y="-99.8" font-family="Times,serif" font-size="14.00">PaginationNavItem</text>
</g>
<!-- PaginationNavItem->PaginationModule -->
<g id="edge3" class="edge">
<title>PaginationNavItem->PaginationModule</title>
<path fill="none" stroke="black" d="M683.63,-122.01C683.63,-138.05 683.63,-159 683.63,-159 683.63,-159 569.87,-159 569.87,-159"/>
<polygon fill="black" stroke="black" points="569.87,-155.5 559.87,-159 569.87,-162.5 569.87,-155.5"/>
</g>
<!-- PaginationOverflow -->
<g id="node4" class="node">
<title>PaginationOverflow</title>
<polygon fill="#ffffb3" stroke="black" points="633.52,-122 504.48,-122 504.48,-86 633.52,-86 633.52,-122"/>
<text text-anchor="middle" x="569" y="-99.8" font-family="Times,serif" font-size="14.00">PaginationOverflow</text>
</g>
<!-- PaginationOverflow->PaginationModule -->
<g id="edge4" class="edge">
<title>PaginationOverflow->PaginationModule</title>
<path fill="none" stroke="black" d="M531.98,-122.11C531.98,-122.11 531.98,-140.99 531.98,-140.99"/>
<polygon fill="black" stroke="black" points="528.48,-140.99 531.98,-150.99 535.48,-140.99 528.48,-140.99"/>
</g>
<!-- Pagination -->
<g id="node10" class="node">
<title>Pagination </title>
<polygon fill="#fb8072" stroke="black" points="715.88,-252 636.12,-252 636.12,-216 715.88,-216 715.88,-252"/>
<text text-anchor="middle" x="676" y="-229.8" font-family="Times,serif" font-size="14.00">Pagination </text>
</g>
<!-- PaginationModule->Pagination -->
<g id="edge9" class="edge">
<title>PaginationModule->Pagination </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M559.79,-180C599.34,-180 643.94,-180 643.94,-180 643.94,-180 643.94,-205.72 643.94,-205.72"/>
<polygon fill="black" stroke="black" points="640.44,-205.72 643.94,-215.72 647.44,-205.72 640.44,-205.72"/>
</g>
<!-- PaginationNav -->
<g id="node11" class="node">
<title>PaginationNav </title>
<polygon fill="#fb8072" stroke="black" points="618.21,-252 515.79,-252 515.79,-216 618.21,-216 618.21,-252"/>
<text text-anchor="middle" x="567" y="-229.8" font-family="Times,serif" font-size="14.00">PaginationNav </text>
</g>
<!-- PaginationModule->PaginationNav -->
<g id="edge10" class="edge">
<title>PaginationModule->PaginationNav </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M537.68,-187.11C537.68,-187.11 537.68,-205.99 537.68,-205.99"/>
<polygon fill="black" stroke="black" points="534.18,-205.99 537.68,-215.99 541.18,-205.99 534.18,-205.99"/>
</g>
<!-- PaginationNavItem -->
<g id="node12" class="node">
<title>PaginationNavItem </title>
<polygon fill="#fb8072" stroke="black" points="497.36,-252 368.64,-252 368.64,-216 497.36,-216 497.36,-252"/>
<text text-anchor="middle" x="433" y="-229.8" font-family="Times,serif" font-size="14.00">PaginationNavItem </text>
</g>
<!-- PaginationModule->PaginationNavItem -->
<g id="edge11" class="edge">
<title>PaginationModule->PaginationNavItem </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M468.73,-187.11C468.73,-187.11 468.73,-205.99 468.73,-205.99"/>
<polygon fill="black" stroke="black" points="465.23,-205.99 468.73,-215.99 472.23,-205.99 465.23,-205.99"/>
</g>
<!-- PaginationOverflow -->
<g id="node13" class="node">
<title>PaginationOverflow </title>
<polygon fill="#fb8072" stroke="black" points="350.52,-252 217.48,-252 217.48,-216 350.52,-216 350.52,-252"/>
<text text-anchor="middle" x="284" y="-229.8" font-family="Times,serif" font-size="14.00">PaginationOverflow </text>
</g>
<!-- PaginationModule->PaginationOverflow -->
<g id="edge12" class="edge">
<title>PaginationModule->PaginationOverflow </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M440.11,-180C378.04,-180 290.01,-180 290.01,-180 290.01,-180 290.01,-205.72 290.01,-205.72"/>
<polygon fill="black" stroke="black" points="286.51,-205.72 290.01,-215.72 293.51,-205.72 286.51,-205.72"/>
</g>
<!-- ButtonModule -->
<g id="node6" class="node">
<title>ButtonModule</title>
<polygon fill="#8dd3c7" stroke="black" points="479.67,-122 476.67,-126 455.67,-126 452.67,-122 382.33,-122 382.33,-86 479.67,-86 479.67,-122"/>
<text text-anchor="middle" x="431" y="-99.8" font-family="Times,serif" font-size="14.00">ButtonModule</text>
</g>
<!-- ButtonModule->PaginationModule -->
<g id="edge5" class="edge">
<title>ButtonModule->PaginationModule</title>
<path fill="none" stroke="black" d="M460.06,-122.11C460.06,-122.11 460.06,-140.99 460.06,-140.99"/>
<polygon fill="black" stroke="black" points="456.56,-140.99 460.06,-150.99 463.56,-140.99 456.56,-140.99"/>
</g>
<!-- ExperimentalModule -->
<g id="node7" class="node">
<title>ExperimentalModule</title>
<polygon fill="#8dd3c7" stroke="black" points="364.47,-122 361.47,-126 340.47,-126 337.47,-122 229.53,-122 229.53,-86 364.47,-86 364.47,-122"/>
<text text-anchor="middle" x="297" y="-99.8" font-family="Times,serif" font-size="14.00">ExperimentalModule</text>
</g>
<!-- ExperimentalModule->PaginationModule -->
<g id="edge6" class="edge">
<title>ExperimentalModule->PaginationModule</title>
<path fill="none" stroke="black" d="M357.5,-122.01C357.5,-138.05 357.5,-159 357.5,-159 357.5,-159 429.98,-159 429.98,-159"/>
<polygon fill="black" stroke="black" points="429.98,-162.5 439.98,-159 429.98,-155.5 429.98,-162.5"/>
</g>
<!-- I18nModule -->
<g id="node8" class="node">
<title>I18nModule</title>
<polygon fill="#8dd3c7" stroke="black" points="211.71,-122 208.71,-126 187.71,-126 184.71,-122 126.29,-122 126.29,-86 211.71,-86 211.71,-122"/>
<text text-anchor="middle" x="169" y="-99.8" font-family="Times,serif" font-size="14.00">I18nModule</text>
</g>
<!-- I18nModule->PaginationModule -->
<g id="edge7" class="edge">
<title>I18nModule->PaginationModule</title>
<path fill="none" stroke="black" d="M169,-122.27C169,-140.56 169,-166 169,-166 169,-166 430.06,-166 430.06,-166"/>
<polygon fill="black" stroke="black" points="430.06,-169.5 440.06,-166 430.06,-162.5 430.06,-169.5"/>
</g>
<!-- IconModule -->
<g id="node9" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="108.43,-122 105.43,-126 84.43,-126 81.43,-122 23.57,-122 23.57,-86 108.43,-86 108.43,-122"/>
<text text-anchor="middle" x="66" y="-99.8" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->PaginationModule -->
<g id="edge8" class="edge">
<title>IconModule->PaginationModule</title>
<path fill="none" stroke="black" d="M66,-122.13C66,-142.57 66,-173 66,-173 66,-173 430.11,-173 430.11,-173"/>
<polygon fill="black" stroke="black" points="430.11,-176.5 440.11,-173 430.11,-169.5 430.11,-176.5"/>
</g>
</g>
</svg>
</div>
<i id="fullscreen" class="icon ion-ios-resize module-graph-fullscreen-btn" aria-hidden="true"></i>
<div class="btn-group size-buttons">
<button id="zoom-in" class="btn btn-default btn-sm">Zoom in</button>
<button id="reset" class="btn btn-default btn-sm">Reset</button>
<button id="zoom-out" class="btn btn-default btn-sm">Zoom out</button>
</div>
</div>
<script src="../js/libs/svg-pan-zoom.min.js"></script>
<script src="../js/svg-pan-zoom.controls.js"></script>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
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>
</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.module.ts</code>
</p>
<div class="container-fluid module">
<div class="row">
<div class="col-sm-3">
<h3>Declarations<a href="https://angular.io/api/core/NgModule#declarations" target="_blank" rel="noopener noreferrer"
title="Official documentation about module declarations"><span class="icon ion-ios-information-circle-outline"></span></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/Pagination.html">Pagination</a>
</li>
<li class="list-group-item">
<a href="../components/PaginationNav.html">PaginationNav</a>
</li>
<li class="list-group-item">
<a href="../components/PaginationNavItem.html">PaginationNavItem</a>
</li>
<li class="list-group-item">
<a href="../components/PaginationOverflow.html">PaginationOverflow</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Imports<a href="https://angular.io/api/core/NgModule#imports" target="_blank" rel="noopener noreferrer"
title="Official documentation about module imports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../modules/ButtonModule.html">ButtonModule</a>
</li>
<li class="list-group-item">
<a href="../modules/ExperimentalModule.html">ExperimentalModule</a>
</li>
<li class="list-group-item">
<a href="../modules/I18nModule.html">I18nModule</a>
</li>
<li class="list-group-item">
<a href="../modules/IconModule.html">IconModule</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank" rel="noopener noreferrer"
title="Official documentation about module exports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/Pagination.html">Pagination</a>
</li>
<li class="list-group-item">
<a href="../components/PaginationNav.html">PaginationNav</a>
</li>
<li class="list-group-item">
<a href="../components/PaginationNavItem.html">PaginationNavItem</a>
</li>
<li class="list-group-item">
<a href="../components/PaginationOverflow.html">PaginationOverflow</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { NgModule } from "@angular/core";
import { CommonModule } from "@angular/common";
import { FormsModule } from "@angular/forms";
import { Pagination } from "./pagination.component";
import { I18nModule } from "carbon-components-angular/i18n";
import { ExperimentalModule } from "carbon-components-angular/experimental";
import { PaginationNav } from "./pagination-nav/pagination-nav.component";
import { PaginationNavItem } from "./pagination-nav/pagination-item.component";
import { PaginationOverflow } from "./pagination-nav/pagination-overflow.component";
import { IconModule } from "carbon-components-angular/icon";
import { ButtonModule } from "carbon-components-angular/forms";
@NgModule({
declarations: [
Pagination,
PaginationNav,
PaginationNavItem,
PaginationOverflow
],
exports: [
Pagination,
PaginationNav,
PaginationNavItem,
PaginationOverflow
],
imports: [
CommonModule,
FormsModule,
I18nModule,
ExperimentalModule,
IconModule,
ButtonModule
]
})
export class PaginationModule {}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'PaginationModule.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
<footer class="carbon">
<dds-footer-container key="footer" disable-locale-button="true" size="micro" />
</footer>
<script
key="8"
type="module"
src="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/footer.min.js">
</script>
<!-- Storybook override -->
<script>
document.title = "Carbon Components Angular";
</script>
<script
src="//1.www.s81c.com/common/stats/ibm-common.js"
type="text/javascript"
async="async">
</script>
</body>
</html>