carbon-components-angular
Version:
Next generation components
458 lines (393 loc) • 19 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" >CodeSnippetModule</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="576pt" height="284pt"
viewBox="0.00 0.00 576.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 572,-280 572,4 -4,4"/>
<text text-anchor="start" x="263.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="50,-10 50,-30 70,-30 70,-10 50,-10"/>
<text text-anchor="start" x="73.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="163,-10 163,-30 183,-30 183,-10 163,-10"/>
<text text-anchor="start" x="186.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="249,-10 249,-30 269,-30 269,-10 249,-10"/>
<text text-anchor="start" x="272.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="346,-10 346,-30 366,-30 366,-10 346,-10"/>
<text text-anchor="start" x="369.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="442,-10 442,-30 462,-30 462,-10 442,-10"/>
<text text-anchor="start" x="465.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_CodeSnippetModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-268 560,-268 560,-70 8,-70"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_CodeSnippetModule_exports</title>
<polygon fill="none" stroke="black" points="220,-208 220,-260 328,-260 328,-208 220,-208"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_CodeSnippetModule_declarations</title>
<polygon fill="none" stroke="black" points="448,-78 448,-130 552,-130 552,-78 448,-78"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_CodeSnippetModule_imports</title>
<polygon fill="none" stroke="black" points="16,-78 16,-130 440,-130 440,-78 16,-78"/>
</g>
<!-- CodeSnippet -->
<g id="node1" class="node">
<title>CodeSnippet</title>
<polygon fill="#ffffb3" stroke="black" points="544.33,-122 455.67,-122 455.67,-86 544.33,-86 544.33,-122"/>
<text text-anchor="middle" x="500" y="-99.8" font-family="Times,serif" font-size="14.00">CodeSnippet</text>
</g>
<!-- CodeSnippetModule -->
<g id="node2" class="node">
<title>CodeSnippetModule</title>
<polygon fill="#8dd3c7" stroke="black" points="339.88,-187 336.88,-191 315.88,-191 312.88,-187 208.12,-187 208.12,-151 339.88,-151 339.88,-187"/>
<text text-anchor="middle" x="274" y="-164.8" font-family="Times,serif" font-size="14.00">CodeSnippetModule</text>
</g>
<!-- CodeSnippet->CodeSnippetModule -->
<g id="edge1" class="edge">
<title>CodeSnippet->CodeSnippetModule</title>
<path fill="none" stroke="black" d="M500,-122.11C500,-141.34 500,-169 500,-169 500,-169 349.98,-169 349.98,-169"/>
<polygon fill="black" stroke="black" points="349.98,-165.5 339.98,-169 349.98,-172.5 349.98,-165.5"/>
</g>
<!-- CodeSnippet -->
<g id="node7" class="node">
<title>CodeSnippet </title>
<polygon fill="#fb8072" stroke="black" points="319.83,-252 228.17,-252 228.17,-216 319.83,-216 319.83,-252"/>
<text text-anchor="middle" x="274" y="-229.8" font-family="Times,serif" font-size="14.00">CodeSnippet </text>
</g>
<!-- CodeSnippetModule->CodeSnippet -->
<g id="edge6" class="edge">
<title>CodeSnippetModule->CodeSnippet </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M274,-187.11C274,-187.11 274,-205.99 274,-205.99"/>
<polygon fill="black" stroke="black" points="270.5,-205.99 274,-215.99 277.5,-205.99 270.5,-205.99"/>
</g>
<!-- ButtonModule -->
<g id="node3" class="node">
<title>ButtonModule</title>
<polygon fill="#8dd3c7" stroke="black" points="431.67,-122 428.67,-126 407.67,-126 404.67,-122 334.33,-122 334.33,-86 431.67,-86 431.67,-122"/>
<text text-anchor="middle" x="383" y="-99.8" font-family="Times,serif" font-size="14.00">ButtonModule</text>
</g>
<!-- ButtonModule->CodeSnippetModule -->
<g id="edge2" class="edge">
<title>ButtonModule->CodeSnippetModule</title>
<path fill="none" stroke="black" d="M333.89,-104C328.77,-104 325.39,-104 325.39,-104 325.39,-104 325.39,-140.89 325.39,-140.89"/>
<polygon fill="black" stroke="black" points="321.89,-140.89 325.39,-150.89 328.89,-140.89 321.89,-140.89"/>
</g>
<!-- I18nModule -->
<g id="node4" class="node">
<title>I18nModule</title>
<polygon fill="#8dd3c7" stroke="black" points="316.71,-122 313.71,-126 292.71,-126 289.71,-122 231.29,-122 231.29,-86 316.71,-86 316.71,-122"/>
<text text-anchor="middle" x="274" y="-99.8" font-family="Times,serif" font-size="14.00">I18nModule</text>
</g>
<!-- I18nModule->CodeSnippetModule -->
<g id="edge3" class="edge">
<title>I18nModule->CodeSnippetModule</title>
<path fill="none" stroke="black" d="M274,-122.11C274,-122.11 274,-140.99 274,-140.99"/>
<polygon fill="black" stroke="black" points="270.5,-140.99 274,-150.99 277.5,-140.99 270.5,-140.99"/>
</g>
<!-- IconModule -->
<g id="node5" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="213.43,-122 210.43,-126 189.43,-126 186.43,-122 128.57,-122 128.57,-86 213.43,-86 213.43,-122"/>
<text text-anchor="middle" x="171" y="-99.8" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->CodeSnippetModule -->
<g id="edge4" class="edge">
<title>IconModule->CodeSnippetModule</title>
<path fill="none" stroke="black" d="M213.37,-104C218.68,-104 222.3,-104 222.3,-104 222.3,-104 222.3,-140.89 222.3,-140.89"/>
<polygon fill="black" stroke="black" points="218.8,-140.89 222.3,-150.89 225.8,-140.89 218.8,-140.89"/>
</g>
<!-- UtilsModule -->
<g id="node6" class="node">
<title>UtilsModule</title>
<polygon fill="#8dd3c7" stroke="black" points="110.27,-122 107.27,-126 86.27,-126 83.27,-122 23.73,-122 23.73,-86 110.27,-86 110.27,-122"/>
<text text-anchor="middle" x="67" y="-99.8" font-family="Times,serif" font-size="14.00">UtilsModule</text>
</g>
<!-- UtilsModule->CodeSnippetModule -->
<g id="edge5" class="edge">
<title>UtilsModule->CodeSnippetModule</title>
<path fill="none" stroke="black" d="M67,-122.11C67,-141.34 67,-169 67,-169 67,-169 197.93,-169 197.93,-169"/>
<polygon fill="black" stroke="black" points="197.93,-172.5 207.93,-169 197.93,-165.5 197.93,-172.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/code-snippet/code-snippet.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/CodeSnippet.html">CodeSnippet</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/I18nModule.html">I18nModule</a>
</li>
<li class="list-group-item">
<a href="../modules/IconModule.html">IconModule</a>
</li>
<li class="list-group-item">
<a href="../modules/UtilsModule.html">UtilsModule</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/CodeSnippet.html">CodeSnippet</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">// modules
import { NgModule } from "@angular/core";
import { CommonModule } from "@angular/common";
import { ButtonModule } from "carbon-components-angular/button";
import { IconModule } from "carbon-components-angular/icon";
import { I18nModule } from "carbon-components-angular/i18n";
import { UtilsModule } from "carbon-components-angular/utils";
// imports
import { CodeSnippet } from "./code-snippet.component";
@NgModule({
declarations: [
CodeSnippet
],
exports: [
CodeSnippet
],
imports: [
CommonModule,
ButtonModule,
I18nModule,
UtilsModule,
IconModule
]
})
export class CodeSnippetModule { }
</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 = 'CodeSnippetModule.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>