carbon-components-angular
Version:
Next generation components
534 lines (469 loc) • 23.3 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" >TagModule</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="802pt" height="284pt"
viewBox="0.00 0.00 802.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 798,-280 798,4 -4,4"/>
<text text-anchor="start" x="376.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="163,-10 163,-30 183,-30 183,-10 163,-10"/>
<text text-anchor="start" x="186.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="276,-10 276,-30 296,-30 296,-10 276,-10"/>
<text text-anchor="start" x="299.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="362,-10 362,-30 382,-30 382,-10 362,-10"/>
<text text-anchor="start" x="385.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="459,-10 459,-30 479,-30 479,-10 459,-10"/>
<text text-anchor="start" x="482.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="555,-10 555,-30 575,-30 575,-10 555,-10"/>
<text text-anchor="start" x="578.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_TagModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-268 786,-268 786,-70 8,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_TagModule_declarations</title>
<polygon fill="none" stroke="black" points="124,-78 124,-130 778,-130 778,-78 124,-78"/>
</g>
<g id="clust8" class="cluster">
<title>cluster_TagModule_imports</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 116,-130 116,-78 16,-78"/>
</g>
<g id="clust9" class="cluster">
<title>cluster_TagModule_exports</title>
<polygon fill="none" stroke="black" points="63,-208 63,-260 731,-260 731,-208 63,-208"/>
</g>
<!-- Tag -->
<g id="node1" class="node">
<title>Tag</title>
<polygon fill="#ffffb3" stroke="black" points="770,-122 716,-122 716,-86 770,-86 770,-122"/>
<text text-anchor="middle" x="743" y="-99.8" font-family="Times,serif" font-size="14.00">Tag</text>
</g>
<!-- TagModule -->
<g id="node6" class="node">
<title>TagModule</title>
<polygon fill="#8dd3c7" stroke="black" points="542.82,-187 539.82,-191 518.82,-191 515.82,-187 461.18,-187 461.18,-151 542.82,-151 542.82,-187"/>
<text text-anchor="middle" x="502" y="-164.8" font-family="Times,serif" font-size="14.00">TagModule</text>
</g>
<!-- Tag->TagModule -->
<g id="edge1" class="edge">
<title>Tag->TagModule</title>
<path fill="none" stroke="black" d="M719.5,-122.27C719.5,-140.56 719.5,-166 719.5,-166 719.5,-166 552.91,-166 552.91,-166"/>
<polygon fill="black" stroke="black" points="552.91,-162.5 542.91,-166 552.91,-169.5 552.91,-162.5"/>
</g>
<!-- TagFilter -->
<g id="node2" class="node">
<title>TagFilter</title>
<polygon fill="#ffffb3" stroke="black" points="698.1,-122 629.9,-122 629.9,-86 698.1,-86 698.1,-122"/>
<text text-anchor="middle" x="664" y="-99.8" font-family="Times,serif" font-size="14.00">TagFilter</text>
</g>
<!-- TagFilter->TagModule -->
<g id="edge2" class="edge">
<title>TagFilter->TagModule</title>
<path fill="none" stroke="black" d="M640.38,-122.01C640.38,-138.05 640.38,-159 640.38,-159 640.38,-159 552.77,-159 552.77,-159"/>
<polygon fill="black" stroke="black" points="552.77,-155.5 542.77,-159 552.77,-162.5 552.77,-155.5"/>
</g>
<!-- TagIconDirective -->
<g id="node3" class="node">
<title>TagIconDirective</title>
<polygon fill="#ffffb3" stroke="black" points="612.23,-122 497.77,-122 497.77,-86 612.23,-86 612.23,-122"/>
<text text-anchor="middle" x="555" y="-99.8" font-family="Times,serif" font-size="14.00">TagIconDirective</text>
</g>
<!-- TagIconDirective->TagModule -->
<g id="edge3" class="edge">
<title>TagIconDirective->TagModule</title>
<path fill="none" stroke="black" d="M520.15,-122.11C520.15,-122.11 520.15,-140.99 520.15,-140.99"/>
<polygon fill="black" stroke="black" points="516.65,-140.99 520.15,-150.99 523.65,-140.99 516.65,-140.99"/>
</g>
<!-- TagOperationalComponent -->
<g id="node4" class="node">
<title>TagOperationalComponent</title>
<polygon fill="#ffffb3" stroke="black" points="479.68,-122 310.32,-122 310.32,-86 479.68,-86 479.68,-122"/>
<text text-anchor="middle" x="395" y="-99.8" font-family="Times,serif" font-size="14.00">TagOperationalComponent</text>
</g>
<!-- TagOperationalComponent->TagModule -->
<g id="edge4" class="edge">
<title>TagOperationalComponent->TagModule</title>
<path fill="none" stroke="black" d="M470.47,-122.11C470.47,-122.11 470.47,-140.99 470.47,-140.99"/>
<polygon fill="black" stroke="black" points="466.97,-140.99 470.47,-150.99 473.97,-140.99 466.97,-140.99"/>
</g>
<!-- TagSelectableComponent -->
<g id="node5" class="node">
<title>TagSelectableComponent</title>
<polygon fill="#ffffb3" stroke="black" points="292.13,-122 131.87,-122 131.87,-86 292.13,-86 292.13,-122"/>
<text text-anchor="middle" x="212" y="-99.8" font-family="Times,serif" font-size="14.00">TagSelectableComponent</text>
</g>
<!-- TagSelectableComponent->TagModule -->
<g id="edge5" class="edge">
<title>TagSelectableComponent->TagModule</title>
<path fill="none" stroke="black" d="M272.49,-122.01C272.49,-138.05 272.49,-159 272.49,-159 272.49,-159 451.23,-159 451.23,-159"/>
<polygon fill="black" stroke="black" points="451.23,-162.5 461.23,-159 451.23,-155.5 451.23,-162.5"/>
</g>
<!-- Tag -->
<g id="node8" class="node">
<title>Tag </title>
<polygon fill="#fb8072" stroke="black" points="723,-252 669,-252 669,-216 723,-216 723,-252"/>
<text text-anchor="middle" x="696" y="-229.8" font-family="Times,serif" font-size="14.00">Tag </text>
</g>
<!-- TagModule->Tag -->
<g id="edge7" class="edge">
<title>TagModule->Tag </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M542.74,-173C596.26,-173 683.52,-173 683.52,-173 683.52,-173 683.52,-205.7 683.52,-205.7"/>
<polygon fill="black" stroke="black" points="680.02,-205.7 683.52,-215.7 687.02,-205.7 680.02,-205.7"/>
</g>
<!-- TagFilter -->
<g id="node9" class="node">
<title>TagFilter </title>
<polygon fill="#fb8072" stroke="black" points="650.6,-252 579.4,-252 579.4,-216 650.6,-216 650.6,-252"/>
<text text-anchor="middle" x="615" y="-229.8" font-family="Times,serif" font-size="14.00">TagFilter </text>
</g>
<!-- TagModule->TagFilter -->
<g id="edge8" class="edge">
<title>TagModule->TagFilter </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M542.86,-180C568.13,-180 595.78,-180 595.78,-180 595.78,-180 595.78,-205.72 595.78,-205.72"/>
<polygon fill="black" stroke="black" points="592.28,-205.72 595.78,-215.72 599.28,-205.72 592.28,-205.72"/>
</g>
<!-- TagIconDirective -->
<g id="node10" class="node">
<title>TagIconDirective </title>
<polygon fill="#fb8072" stroke="black" points="561.23,-252 442.77,-252 442.77,-216 561.23,-216 561.23,-252"/>
<text text-anchor="middle" x="502" y="-229.8" font-family="Times,serif" font-size="14.00">TagIconDirective </text>
</g>
<!-- TagModule->TagIconDirective -->
<g id="edge9" class="edge">
<title>TagModule->TagIconDirective </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M502,-187.11C502,-187.11 502,-205.99 502,-205.99"/>
<polygon fill="black" stroke="black" points="498.5,-205.99 502,-215.99 505.5,-205.99 498.5,-205.99"/>
</g>
<!-- TagOperationalComponent -->
<g id="node11" class="node">
<title>TagOperationalComponent </title>
<polygon fill="#fb8072" stroke="black" points="425.18,-252 252.82,-252 252.82,-216 425.18,-216 425.18,-252"/>
<text text-anchor="middle" x="339" y="-229.8" font-family="Times,serif" font-size="14.00">TagOperationalComponent </text>
</g>
<!-- TagModule->TagOperationalComponent -->
<g id="edge10" class="edge">
<title>TagModule->TagOperationalComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M461.03,-180C421.59,-180 367.88,-180 367.88,-180 367.88,-180 367.88,-205.72 367.88,-205.72"/>
<polygon fill="black" stroke="black" points="364.38,-205.72 367.88,-215.72 371.38,-205.72 364.38,-205.72"/>
</g>
<!-- TagSelectableComponent -->
<g id="node12" class="node">
<title>TagSelectableComponent </title>
<polygon fill="#fb8072" stroke="black" points="235.13,-252 70.87,-252 70.87,-216 235.13,-216 235.13,-252"/>
<text text-anchor="middle" x="153" y="-229.8" font-family="Times,serif" font-size="14.00">TagSelectableComponent </text>
</g>
<!-- TagModule->TagSelectableComponent -->
<g id="edge11" class="edge">
<title>TagModule->TagSelectableComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M461.32,-173C375.42,-173 183.38,-173 183.38,-173 183.38,-173 183.38,-205.7 183.38,-205.7"/>
<polygon fill="black" stroke="black" points="179.88,-205.7 183.38,-215.7 186.88,-205.7 179.88,-205.7"/>
</g>
<!-- IconModule -->
<g id="node7" 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->TagModule -->
<g id="edge6" class="edge">
<title>IconModule->TagModule</title>
<path fill="none" stroke="black" d="M89.57,-122.27C89.57,-140.56 89.57,-166 89.57,-166 89.57,-166 451.33,-166 451.33,-166"/>
<polygon fill="black" stroke="black" points="451.33,-169.5 461.33,-166 451.33,-162.5 451.33,-169.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/tag/tag.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/Tag.html">Tag</a>
</li>
<li class="list-group-item">
<a href="../components/TagFilter.html">TagFilter</a>
</li>
<li class="list-group-item">
<a href="../directives/TagIconDirective.html">TagIconDirective</a>
</li>
<li class="list-group-item">
<a href="../components/TagOperationalComponent.html">TagOperationalComponent</a>
</li>
<li class="list-group-item">
<a href="../components/TagSelectableComponent.html">TagSelectableComponent</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/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/Tag.html">Tag</a>
</li>
<li class="list-group-item">
<a href="../components/TagFilter.html">TagFilter</a>
</li>
<li class="list-group-item">
<a href="../directives/TagIconDirective.html">TagIconDirective</a>
</li>
<li class="list-group-item">
<a href="../components/TagOperationalComponent.html">TagOperationalComponent</a>
</li>
<li class="list-group-item">
<a href="../components/TagSelectableComponent.html">TagSelectableComponent</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 { Tag } from "./tag.component";
import { TagFilter } from "./tag-filter.component";
import { IconModule } from "carbon-components-angular/icon";
import { TagIconDirective } from "./tag-icon.directive";
import { TagSelectableComponent } from "./tag-selectable.component";
import { TagOperationalComponent } from "./tag-operational.component";
@NgModule({
declarations: [
Tag,
TagFilter,
TagIconDirective,
TagSelectableComponent,
TagOperationalComponent
],
exports: [
Tag,
TagFilter,
TagIconDirective,
TagSelectableComponent,
TagOperationalComponent
],
imports: [CommonModule, IconModule]
})
export class TagModule {}
</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 = 'TagModule.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>