carbon-components-angular
Version:
Next generation components
524 lines (459 loc) • 22.9 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" >ComboBoxModule</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="776pt" height="396pt"
viewBox="0.00 0.00 776.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 772,-391.59 772,4 -4,4"/>
<text text-anchor="start" x="363.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="150,-10 150,-30 170,-30 170,-10 150,-10"/>
<text text-anchor="start" x="173.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="263,-10 263,-30 283,-30 283,-10 263,-10"/>
<text text-anchor="start" x="286.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="349,-10 349,-30 369,-30 369,-10 349,-10"/>
<text text-anchor="start" x="372.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="446,-10 446,-30 466,-30 466,-10 446,-10"/>
<text text-anchor="start" x="469.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="542,-10 542,-30 562,-30 562,-10 542,-10"/>
<text text-anchor="start" x="565.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_ComboBoxModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-379.59 760,-379.59 760,-70 8,-70"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_ComboBoxModule_exports</title>
<polygon fill="none" stroke="black" points="280,-319.59 280,-371.59 520,-371.59 520,-319.59 280,-319.59"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_ComboBoxModule_imports</title>
<polygon fill="none" stroke="black" points="306,-189.59 306,-241.59 752,-241.59 752,-189.59 306,-189.59"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_ComboBoxModule_declarations</title>
<polygon fill="none" stroke="black" points="202,-189.59 202,-241.59 298,-241.59 298,-189.59 202,-189.59"/>
</g>
<g id="clust3" class="cluster">
<title>cluster_ComboBoxModule_ComboBox_providers</title>
<polygon fill="none" stroke="black" points="16,-78 16,-176.59 660,-176.59 660,-78 16,-78"/>
</g>
<g id="clust7" class="cluster">
<title>cluster_ComboBoxModule_providers</title>
<polygon fill="none" stroke="black" points="16,-189.59 16,-241.59 194,-241.59 194,-189.59 16,-189.59"/>
</g>
<!-- ComboBox -->
<g id="node1" class="node">
<title>ComboBox</title>
<polygon fill="#ffffb3" stroke="black" points="290.06,-233.59 209.94,-233.59 209.94,-197.59 290.06,-197.59 290.06,-233.59"/>
<text text-anchor="middle" x="250" y="-211.39" font-family="Times,serif" font-size="14.00">ComboBox</text>
</g>
<!-- ComboBoxModule -->
<g id="node2" class="node">
<title>ComboBoxModule</title>
<polygon fill="#8dd3c7" stroke="black" points="471.11,-298.59 468.11,-302.59 447.11,-302.59 444.11,-298.59 346.89,-298.59 346.89,-262.59 471.11,-262.59 471.11,-298.59"/>
<text text-anchor="middle" x="409" y="-276.39" font-family="Times,serif" font-size="14.00">ComboBoxModule</text>
</g>
<!-- ComboBox->ComboBoxModule -->
<g id="edge1" class="edge">
<title>ComboBox->ComboBoxModule</title>
<path fill="none" stroke="black" d="M248.63,-233.61C248.63,-250.96 248.63,-274.59 248.63,-274.59 248.63,-274.59 336.54,-274.59 336.54,-274.59"/>
<polygon fill="black" stroke="black" points="336.54,-278.09 346.54,-274.59 336.54,-271.09 336.54,-278.09"/>
</g>
<!-- ComboBox -->
<g id="node8" class="node">
<title>ComboBox </title>
<polygon fill="#fb8072" stroke="black" points="512.06,-363.59 427.94,-363.59 427.94,-327.59 512.06,-327.59 512.06,-363.59"/>
<text text-anchor="middle" x="470" y="-341.39" font-family="Times,serif" font-size="14.00">ComboBox </text>
</g>
<!-- ComboBoxModule->ComboBox -->
<g id="edge7" class="edge">
<title>ComboBoxModule->ComboBox </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M449.51,-298.7C449.51,-298.7 449.51,-317.58 449.51,-317.58"/>
<polygon fill="black" stroke="black" points="446.01,-317.58 449.51,-327.58 453.01,-317.58 446.01,-317.58"/>
</g>
<!-- DropdownModule -->
<g id="node9" class="node">
<title>DropdownModule </title>
<polygon fill="#fb8072" stroke="black" points="410.42,-363.59 287.58,-363.59 287.58,-327.59 410.42,-327.59 410.42,-363.59"/>
<text text-anchor="middle" x="349" y="-341.39" font-family="Times,serif" font-size="14.00">DropdownModule </text>
</g>
<!-- ComboBoxModule->DropdownModule -->
<g id="edge8" class="edge">
<title>ComboBoxModule->DropdownModule </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M378.7,-298.7C378.7,-298.7 378.7,-317.58 378.7,-317.58"/>
<polygon fill="black" stroke="black" points="375.2,-317.58 378.7,-327.58 382.2,-317.58 375.2,-317.58"/>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: ComboBox, multi: true
} -->
<g id="node3" class="node">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: ComboBox, multi: true
}</title>
<ellipse fill="#fdb462" stroke="black" cx="338" cy="-127.3" rx="314.1" ry="41.09"/>
<text text-anchor="middle" x="338" y="-139.9" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="338" y="-123.1" font-family="Times,serif" font-size="14.00">    provide: NG_VALUE_ACCESSOR, useExisting: ComboBox, multi: true</text>
<text text-anchor="middle" x="338" y="-106.3" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: ComboBox, multi: true
}->ComboBox -->
<g id="edge2" class="edge">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: ComboBox, multi: true
}->ComboBox</title>
<path fill="none" stroke="black" d="M250,-167.05C250,-167.05 250,-187.45 250,-187.45"/>
<polygon fill="black" stroke="black" points="246.5,-187.45 250,-197.45 253.5,-187.45 246.5,-187.45"/>
</g>
<!-- DropdownModule -->
<g id="node4" class="node">
<title>DropdownModule</title>
<polygon fill="#8dd3c7" stroke="black" points="743.92,-233.59 740.92,-237.59 719.92,-237.59 716.92,-233.59 624.08,-233.59 624.08,-197.59 743.92,-197.59 743.92,-233.59"/>
<text text-anchor="middle" x="684" y="-211.39" font-family="Times,serif" font-size="14.00">DropdownModule</text>
</g>
<!-- DropdownModule->ComboBoxModule -->
<g id="edge3" class="edge">
<title>DropdownModule->ComboBoxModule</title>
<path fill="none" stroke="black" d="M684,-233.87C684,-254.91 684,-286.59 684,-286.59 684,-286.59 481.06,-286.59 481.06,-286.59"/>
<polygon fill="black" stroke="black" points="481.06,-283.09 471.06,-286.59 481.06,-290.09 481.06,-283.09"/>
</g>
<!-- I18nModule -->
<g id="node5" class="node">
<title>I18nModule</title>
<polygon fill="#8dd3c7" stroke="black" points="606.71,-233.59 603.71,-237.59 582.71,-237.59 579.71,-233.59 521.29,-233.59 521.29,-197.59 606.71,-197.59 606.71,-233.59"/>
<text text-anchor="middle" x="564" y="-211.39" font-family="Times,serif" font-size="14.00">I18nModule</text>
</g>
<!-- I18nModule->ComboBoxModule -->
<g id="edge4" class="edge">
<title>I18nModule->ComboBoxModule</title>
<path fill="none" stroke="black" d="M564,-233.61C564,-250.96 564,-274.59 564,-274.59 564,-274.59 481.15,-274.59 481.15,-274.59"/>
<polygon fill="black" stroke="black" points="481.15,-271.09 471.15,-274.59 481.15,-278.09 481.15,-271.09"/>
</g>
<!-- IconModule -->
<g id="node6" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="503.43,-233.59 500.43,-237.59 479.43,-237.59 476.43,-233.59 418.57,-233.59 418.57,-197.59 503.43,-197.59 503.43,-233.59"/>
<text text-anchor="middle" x="461" y="-211.39" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->ComboBoxModule -->
<g id="edge5" class="edge">
<title>IconModule->ComboBoxModule</title>
<path fill="none" stroke="black" d="M444.92,-233.7C444.92,-233.7 444.92,-252.58 444.92,-252.58"/>
<polygon fill="black" stroke="black" points="441.42,-252.58 444.92,-262.58 448.42,-252.58 441.42,-252.58"/>
</g>
<!-- UtilsModule -->
<g id="node7" class="node">
<title>UtilsModule</title>
<polygon fill="#8dd3c7" stroke="black" points="400.27,-233.59 397.27,-237.59 376.27,-237.59 373.27,-233.59 313.73,-233.59 313.73,-197.59 400.27,-197.59 400.27,-233.59"/>
<text text-anchor="middle" x="357" y="-211.39" font-family="Times,serif" font-size="14.00">UtilsModule</text>
</g>
<!-- UtilsModule->ComboBoxModule -->
<g id="edge6" class="edge">
<title>UtilsModule->ComboBoxModule</title>
<path fill="none" stroke="black" d="M373.66,-233.7C373.66,-233.7 373.66,-252.58 373.66,-252.58"/>
<polygon fill="black" stroke="black" points="370.16,-252.58 373.66,-262.58 377.16,-252.58 370.16,-252.58"/>
</g>
<!-- DropdownService -->
<g id="node10" class="node">
<title>DropdownService</title>
<ellipse fill="#fdb462" stroke="black" cx="105" cy="-215.59" rx="81.08" ry="18"/>
<text text-anchor="middle" x="105" y="-211.39" font-family="Times,serif" font-size="14.00">DropdownService</text>
</g>
<!-- DropdownService->ComboBoxModule -->
<g id="edge9" class="edge">
<title>DropdownService->ComboBoxModule</title>
<path fill="none" stroke="black" d="M105,-233.87C105,-254.91 105,-286.59 105,-286.59 105,-286.59 336.75,-286.59 336.75,-286.59"/>
<polygon fill="black" stroke="black" points="336.75,-290.09 346.75,-286.59 336.75,-283.09 336.75,-290.09"/>
</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/combobox/combobox.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/ComboBox.html">ComboBox</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/DropdownService.html">DropdownService</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/DropdownModule.html">DropdownModule</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/ComboBox.html">ComboBox</a>
</li>
<li class="list-group-item">
<a href="../modules/DropdownModule.html">DropdownModule</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 { ComboBox } from "./combobox.component";
import { DropdownModule, DropdownService } from "carbon-components-angular/dropdown";
import { I18nModule } from "carbon-components-angular/i18n";
import { UtilsModule } from "carbon-components-angular/utils";
import { IconModule } from "carbon-components-angular/icon";
@NgModule({
declarations: [
ComboBox
],
exports: [
ComboBox,
DropdownModule
],
imports: [
CommonModule,
DropdownModule,
I18nModule,
UtilsModule,
IconModule
],
providers: [ DropdownService ]
})
export class ComboBoxModule {}
</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 = 'ComboBoxModule.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>