carbon-components-angular
Version:
Next generation components
484 lines (419 loc) • 20.6 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" >CheckboxModule</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="1296pt" height="396pt"
viewBox="0.00 0.00 1296.00 395.59" 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 391.59)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-391.59 1292,-391.59 1292,4 -4,4"/>
<text text-anchor="start" x="623.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="410,-10 410,-30 430,-30 430,-10 410,-10"/>
<text text-anchor="start" x="433.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="523,-10 523,-30 543,-30 543,-10 523,-10"/>
<text text-anchor="start" x="546.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="609,-10 609,-30 629,-30 629,-10 609,-10"/>
<text text-anchor="start" x="632.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="706,-10 706,-30 726,-30 726,-10 706,-10"/>
<text text-anchor="start" x="729.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="802,-10 802,-30 822,-30 822,-10 802,-10"/>
<text text-anchor="start" x="825.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_CheckboxModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-379.59 1280,-379.59 1280,-70 8,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_CheckboxModule_declarations</title>
<polygon fill="none" stroke="black" points="522,-189.59 522,-241.59 737,-241.59 737,-189.59 522,-189.59"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_CheckboxModule_imports</title>
<polygon fill="none" stroke="black" points="745,-189.59 745,-241.59 845,-241.59 845,-189.59 745,-189.59"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_CheckboxModule_exports</title>
<polygon fill="none" stroke="black" points="573,-319.59 573,-371.59 795,-371.59 795,-319.59 573,-319.59"/>
</g>
<g id="clust3" class="cluster">
<title>cluster_CheckboxModule_Checkbox_providers</title>
<polygon fill="none" stroke="black" points="638,-78 638,-176.59 1272,-176.59 1272,-78 638,-78"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_CheckboxModule_CheckboxGroup_providers</title>
<polygon fill="none" stroke="black" points="16,-101.3 16,-153.3 630,-153.3 630,-101.3 16,-101.3"/>
</g>
<!-- Checkbox -->
<g id="node1" class="node">
<title>Checkbox</title>
<polygon fill="#ffffb3" stroke="black" points="729.27,-233.59 656.73,-233.59 656.73,-197.59 729.27,-197.59 729.27,-233.59"/>
<text text-anchor="middle" x="693" y="-211.39" font-family="Times,serif" font-size="14.00">Checkbox</text>
</g>
<!-- CheckboxModule -->
<g id="node3" class="node">
<title>CheckboxModule</title>
<polygon fill="#8dd3c7" stroke="black" points="751.32,-298.59 748.32,-302.59 727.32,-302.59 724.32,-298.59 634.68,-298.59 634.68,-262.59 751.32,-262.59 751.32,-298.59"/>
<text text-anchor="middle" x="693" y="-276.39" font-family="Times,serif" font-size="14.00">CheckboxModule</text>
</g>
<!-- Checkbox->CheckboxModule -->
<g id="edge1" class="edge">
<title>Checkbox->CheckboxModule</title>
<path fill="none" stroke="black" d="M693,-233.7C693,-233.7 693,-252.58 693,-252.58"/>
<polygon fill="black" stroke="black" points="689.5,-252.58 693,-262.58 696.5,-252.58 689.5,-252.58"/>
</g>
<!-- CheckboxGroup -->
<g id="node2" class="node">
<title>CheckboxGroup</title>
<polygon fill="#ffffb3" stroke="black" points="638.03,-233.59 529.97,-233.59 529.97,-197.59 638.03,-197.59 638.03,-233.59"/>
<text text-anchor="middle" x="584" y="-211.39" font-family="Times,serif" font-size="14.00">CheckboxGroup</text>
</g>
<!-- CheckboxGroup->CheckboxModule -->
<g id="edge3" class="edge">
<title>CheckboxGroup->CheckboxModule</title>
<path fill="none" stroke="black" d="M638.17,-215.59C640.79,-215.59 642.36,-215.59 642.36,-215.59 642.36,-215.59 642.36,-252.48 642.36,-252.48"/>
<polygon fill="black" stroke="black" points="638.86,-252.48 642.36,-262.48 645.86,-252.48 638.86,-252.48"/>
</g>
<!-- Checkbox -->
<g id="node7" class="node">
<title>Checkbox </title>
<polygon fill="#fb8072" stroke="black" points="787.27,-363.59 710.73,-363.59 710.73,-327.59 787.27,-327.59 787.27,-363.59"/>
<text text-anchor="middle" x="749" y="-341.39" font-family="Times,serif" font-size="14.00">Checkbox </text>
</g>
<!-- CheckboxModule->Checkbox -->
<g id="edge6" class="edge">
<title>CheckboxModule->Checkbox </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M731.01,-298.7C731.01,-298.7 731.01,-317.58 731.01,-317.58"/>
<polygon fill="black" stroke="black" points="727.51,-317.58 731.01,-327.58 734.51,-317.58 727.51,-317.58"/>
</g>
<!-- CheckboxGroup -->
<g id="node8" class="node">
<title>CheckboxGroup </title>
<polygon fill="#fb8072" stroke="black" points="693.03,-363.59 580.97,-363.59 580.97,-327.59 693.03,-327.59 693.03,-363.59"/>
<text text-anchor="middle" x="637" y="-341.39" font-family="Times,serif" font-size="14.00">CheckboxGroup </text>
</g>
<!-- CheckboxModule->CheckboxGroup -->
<g id="edge7" class="edge">
<title>CheckboxModule->CheckboxGroup </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M663.93,-298.7C663.93,-298.7 663.93,-317.58 663.93,-317.58"/>
<polygon fill="black" stroke="black" points="660.43,-317.58 663.93,-327.58 667.43,-317.58 660.43,-317.58"/>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: Checkbox, multi: true
} -->
<g id="node4" class="node">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: Checkbox, multi: true
}</title>
<ellipse fill="#fdb462" stroke="black" cx="955" cy="-127.3" rx="308.58" ry="41.09"/>
<text text-anchor="middle" x="955" y="-139.9" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="955" y="-123.1" font-family="Times,serif" font-size="14.00">    provide: NG_VALUE_ACCESSOR, useExisting: Checkbox, multi: true</text>
<text text-anchor="middle" x="955" y="-106.3" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: Checkbox, multi: true
}->Checkbox -->
<g id="edge2" class="edge">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: Checkbox, multi: true
}->Checkbox</title>
<path fill="none" stroke="black" d="M693,-149.12C693,-149.12 693,-187.58 693,-187.58"/>
<polygon fill="black" stroke="black" points="689.5,-187.58 693,-197.58 696.5,-187.58 689.5,-187.58"/>
</g>
<!-- { provide: CHECKBOX_GROUP_HOST, useExisting: CheckboxGroup } -->
<g id="node5" class="node">
<title>{ provide: CHECKBOX_GROUP_HOST, useExisting: CheckboxGroup }</title>
<ellipse fill="#fdb462" stroke="black" cx="323" cy="-127.3" rx="299.48" ry="18"/>
<text text-anchor="middle" x="323" y="-123.1" font-family="Times,serif" font-size="14.00">{ provide: CHECKBOX_GROUP_HOST, useExisting: CheckboxGroup }</text>
</g>
<!-- { provide: CHECKBOX_GROUP_HOST, useExisting: CheckboxGroup }->CheckboxGroup -->
<g id="edge4" class="edge">
<title>{ provide: CHECKBOX_GROUP_HOST, useExisting: CheckboxGroup }->CheckboxGroup</title>
<path fill="none" stroke="black" d="M575.99,-137.08C575.99,-137.08 575.99,-187.49 575.99,-187.49"/>
<polygon fill="black" stroke="black" points="572.49,-187.49 575.99,-197.49 579.49,-187.49 572.49,-187.49"/>
</g>
<!-- IconModule -->
<g id="node6" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="837.43,-233.59 834.43,-237.59 813.43,-237.59 810.43,-233.59 752.57,-233.59 752.57,-197.59 837.43,-197.59 837.43,-233.59"/>
<text text-anchor="middle" x="795" y="-211.39" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->CheckboxModule -->
<g id="edge5" class="edge">
<title>IconModule->CheckboxModule</title>
<path fill="none" stroke="black" d="M752.69,-215.59C745.48,-215.59 740.27,-215.59 740.27,-215.59 740.27,-215.59 740.27,-252.48 740.27,-252.48"/>
<polygon fill="black" stroke="black" points="736.77,-252.48 740.27,-262.48 743.77,-252.48 736.77,-252.48"/>
</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/checkbox/checkbox.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/Checkbox.html">Checkbox</a>
</li>
<li class="list-group-item">
<a href="../components/CheckboxGroup.html">CheckboxGroup</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/Checkbox.html">Checkbox</a>
</li>
<li class="list-group-item">
<a href="../components/CheckboxGroup.html">CheckboxGroup</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 { FormsModule } from "@angular/forms";
import { CommonModule } from "@angular/common";
// imports
import { Checkbox } from "./checkbox.component";
import { CheckboxGroup } from "./checkbox-group.component";
import { IconModule } from "carbon-components-angular/icon";
@NgModule({
declarations: [
Checkbox,
CheckboxGroup
],
exports: [
Checkbox,
CheckboxGroup
],
imports: [
CommonModule,
FormsModule,
IconModule
]
})
export class CheckboxModule { }
</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 = 'CheckboxModule.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>