carbon-components-angular
Version:
Next generation components
504 lines (439 loc) • 22.2 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" >GridModule</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="1470pt" height="443pt"
viewBox="0.00 0.00 1470.00 443.11" 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 439.11)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-439.11 1466,-439.11 1466,4 -4,4"/>
<text text-anchor="start" x="710.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="497,-10 497,-30 517,-30 517,-10 497,-10"/>
<text text-anchor="start" x="520.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="610,-10 610,-30 630,-30 630,-10 610,-10"/>
<text text-anchor="start" x="633.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="696,-10 696,-30 716,-30 716,-10 696,-10"/>
<text text-anchor="start" x="719.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="793,-10 793,-30 813,-30 813,-10 793,-10"/>
<text text-anchor="start" x="816.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="889,-10 889,-30 909,-30 909,-10 889,-10"/>
<text text-anchor="start" x="912.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_GridModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-427.11 1454,-427.11 1454,-70 8,-70"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_GridModule_GridDirective_providers</title>
<polygon fill="none" stroke="black" points="406,-78 406,-289.11 1446,-289.11 1446,-78 406,-78"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_GridModule_declarations</title>
<polygon fill="none" stroke="black" points="156,-237.11 156,-289.11 398,-289.11 398,-237.11 156,-237.11"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_GridModule_exports</title>
<polygon fill="none" stroke="black" points="99,-367.11 99,-419.11 463,-419.11 463,-367.11 99,-367.11"/>
</g>
<g id="clust9" class="cluster">
<title>cluster_GridModule_providers</title>
<polygon fill="none" stroke="black" points="16,-237.11 16,-289.11 148,-289.11 148,-237.11 16,-237.11"/>
</g>
<!-- ColumnDirective -->
<g id="node1" class="node">
<title>ColumnDirective</title>
<polygon fill="#ffffb3" stroke="black" points="389.7,-281.11 276.3,-281.11 276.3,-245.11 389.7,-245.11 389.7,-281.11"/>
<text text-anchor="middle" x="333" y="-258.91" font-family="Times,serif" font-size="14.00">ColumnDirective</text>
</g>
<!-- GridModule -->
<g id="node4" class="node">
<title>GridModule</title>
<polygon fill="#8dd3c7" stroke="black" points="314.71,-346.11 311.71,-350.11 290.71,-350.11 287.71,-346.11 229.29,-346.11 229.29,-310.11 314.71,-310.11 314.71,-346.11"/>
<text text-anchor="middle" x="272" y="-323.91" font-family="Times,serif" font-size="14.00">GridModule</text>
</g>
<!-- ColumnDirective->GridModule -->
<g id="edge1" class="edge">
<title>ColumnDirective->GridModule</title>
<path fill="none" stroke="black" d="M295.5,-281.21C295.5,-281.21 295.5,-300.1 295.5,-300.1"/>
<polygon fill="black" stroke="black" points="292,-300.1 295.5,-310.1 299,-300.1 292,-300.1"/>
</g>
<!-- GridDirective -->
<g id="node2" class="node">
<title>GridDirective</title>
<polygon fill="#ffffb3" stroke="black" points="739.74,-281.11 646.26,-281.11 646.26,-245.11 739.74,-245.11 739.74,-281.11"/>
<text text-anchor="middle" x="693" y="-258.91" font-family="Times,serif" font-size="14.00">GridDirective</text>
</g>
<!-- GridDirective->GridModule -->
<g id="edge2" class="edge">
<title>GridDirective->GridModule</title>
<path fill="none" stroke="black" d="M693,-281.13C693,-298.48 693,-322.11 693,-322.11 693,-322.11 324.68,-322.11 324.68,-322.11"/>
<polygon fill="black" stroke="black" points="324.68,-318.61 314.68,-322.11 324.68,-325.61 324.68,-318.61"/>
</g>
<!-- RowDirective -->
<g id="node3" class="node">
<title>RowDirective</title>
<polygon fill="#ffffb3" stroke="black" points="258.03,-281.11 163.97,-281.11 163.97,-245.11 258.03,-245.11 258.03,-281.11"/>
<text text-anchor="middle" x="211" y="-258.91" font-family="Times,serif" font-size="14.00">RowDirective</text>
</g>
<!-- RowDirective->GridModule -->
<g id="edge4" class="edge">
<title>RowDirective->GridModule</title>
<path fill="none" stroke="black" d="M243.83,-281.21C243.83,-281.21 243.83,-300.1 243.83,-300.1"/>
<polygon fill="black" stroke="black" points="240.33,-300.1 243.83,-310.1 247.33,-300.1 240.33,-300.1"/>
</g>
<!-- ColumnDirective -->
<g id="node6" class="node">
<title>ColumnDirective </title>
<polygon fill="#fb8072" stroke="black" points="455.2,-411.11 338.8,-411.11 338.8,-375.11 455.2,-375.11 455.2,-411.11"/>
<text text-anchor="middle" x="397" y="-388.91" font-family="Times,serif" font-size="14.00">ColumnDirective </text>
</g>
<!-- GridModule->ColumnDirective -->
<g id="edge5" class="edge">
<title>GridModule->ColumnDirective </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M314.83,-334.11C338.88,-334.11 364.12,-334.11 364.12,-334.11 364.12,-334.11 364.12,-365.09 364.12,-365.09"/>
<polygon fill="black" stroke="black" points="360.63,-365.09 364.12,-375.09 367.63,-365.09 360.63,-365.09"/>
</g>
<!-- GridDirective -->
<g id="node7" class="node">
<title>GridDirective </title>
<polygon fill="#fb8072" stroke="black" points="320.74,-411.11 223.26,-411.11 223.26,-375.11 320.74,-375.11 320.74,-411.11"/>
<text text-anchor="middle" x="272" y="-388.91" font-family="Times,serif" font-size="14.00">GridDirective </text>
</g>
<!-- GridModule->GridDirective -->
<g id="edge6" class="edge">
<title>GridModule->GridDirective </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M272,-346.21C272,-346.21 272,-365.1 272,-365.1"/>
<polygon fill="black" stroke="black" points="268.5,-365.1 272,-375.1 275.5,-365.1 268.5,-365.1"/>
</g>
<!-- RowDirective -->
<g id="node8" class="node">
<title>RowDirective </title>
<polygon fill="#fb8072" stroke="black" points="205.03,-411.11 106.97,-411.11 106.97,-375.11 205.03,-375.11 205.03,-411.11"/>
<text text-anchor="middle" x="156" y="-388.91" font-family="Times,serif" font-size="14.00">RowDirective </text>
</g>
<!-- GridModule->RowDirective -->
<g id="edge7" class="edge">
<title>GridModule->RowDirective </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M229.21,-334.11C206.97,-334.11 184.38,-334.11 184.38,-334.11 184.38,-334.11 184.38,-365.09 184.38,-365.09"/>
<polygon fill="black" stroke="black" points="180.88,-365.09 184.38,-375.09 187.88,-365.09 180.88,-365.09"/>
</g>
<!-- {
   provide: GridService, deps: [[new Optional(), new SkipSelf(), GridService]], useFactory: (parentService: GridService) => {
       return parentService || new GridService();
   }
} -->
<g id="node5" class="node">
<title>{
   provide: GridService, deps: [[new Optional(), new SkipSelf(), GridService]], useFactory: (parentService: GridService) => {
       return parentService || new GridService();
   }
}</title>
<ellipse fill="#fdb462" stroke="black" cx="926" cy="-151.05" rx="512.24" ry="65.11"/>
<text text-anchor="middle" x="926" y="-180.45" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="926" y="-163.65" font-family="Times,serif" font-size="14.00">    provide: GridService, deps: [[new Optional(), new SkipSelf(), GridService]], useFactory: (parentService: GridService) => {</text>
<text text-anchor="middle" x="926" y="-146.85" font-family="Times,serif" font-size="14.00">        return parentService || new GridService();</text>
<text text-anchor="middle" x="926" y="-130.05" font-family="Times,serif" font-size="14.00">    }</text>
<text text-anchor="middle" x="926" y="-113.25" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: GridService, deps: [[new Optional(), new SkipSelf(), GridService]], useFactory: (parentService: GridService) => {
       return parentService || new GridService();
   }
}->GridDirective -->
<g id="edge3" class="edge">
<title>{
   provide: GridService, deps: [[new Optional(), new SkipSelf(), GridService]], useFactory: (parentService: GridService) => {
       return parentService || new GridService();
   }
}->GridDirective</title>
<path fill="none" stroke="black" d="M693,-209.05C693,-209.05 693,-234.89 693,-234.89"/>
<polygon fill="black" stroke="black" points="689.5,-234.89 693,-244.89 696.5,-234.89 689.5,-234.89"/>
</g>
<!-- GridService -->
<g id="node9" class="node">
<title>GridService</title>
<ellipse fill="#fdb462" stroke="black" cx="82" cy="-263.11" rx="57.88" ry="18"/>
<text text-anchor="middle" x="82" y="-258.91" font-family="Times,serif" font-size="14.00">GridService</text>
</g>
<!-- GridService->GridModule -->
<g id="edge8" class="edge">
<title>GridService->GridModule</title>
<path fill="none" stroke="black" d="M123.34,-275.91C123.34,-293.26 123.34,-322.11 123.34,-322.11 123.34,-322.11 219,-322.11 219,-322.11"/>
<polygon fill="black" stroke="black" points="219,-325.61 229,-322.11 219,-318.61 219,-325.61"/>
</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/grid/grid.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="../directives/ColumnDirective.html">ColumnDirective</a>
</li>
<li class="list-group-item">
<a href="../directives/GridDirective.html">GridDirective</a>
</li>
<li class="list-group-item">
<a href="../directives/RowDirective.html">RowDirective</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Providers<a href="https://angular.io/api/core/NgModule#providers" target="_blank" rel="noopener noreferrer"
title="Official documentation about module providers"><span class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../injectables/GridService.html">GridService</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="../directives/ColumnDirective.html">ColumnDirective</a>
</li>
<li class="list-group-item">
<a href="../directives/GridDirective.html">GridDirective</a>
</li>
<li class="list-group-item">
<a href="../directives/RowDirective.html">RowDirective</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 { ColumnDirective } from "./column.directive";
import { RowDirective } from "./row.directive";
import { GridDirective } from "./grid.directive";
import { GridService } from "./grid.service";
@NgModule({
declarations: [
ColumnDirective,
GridDirective,
RowDirective
],
exports: [
ColumnDirective,
GridDirective,
RowDirective
],
providers: [GridService],
imports: [CommonModule]
})
export class GridModule {}
</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 = 'GridModule.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>