carbon-components-angular
Version:
Next generation components
1,174 lines (1,097 loc) • 230 kB
HTML
<!doctype 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">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top d-block d-sm-none">
<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 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="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content component">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Components</li>
<li class="breadcrumb-item"
>
ComboBox</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info" 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>
<li class="nav-item">
<a href="#tree" class="nav-link"
role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</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.component.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Get started with importing the module:</p>
<div><pre class="line-numbers"><code class="language-typescript">import { ComboBoxModule } from 'carbon-components-angular';</code></pre></div><p>ComboBoxes are similar to dropdowns, except a combobox provides an input field for users to search items and (optionally) add their own.
Multi-select comboboxes also provide "pills" of selected items.</p>
<p><a href="../../?path=/story/components-combobox--basic">See demo</a></p>
</p>
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code>OnChanges</code>
<code>AfterViewInit</code>
<code>AfterContentInit</code>
<code>OnDestroy</code>
</p>
<section data-compodoc="block-metadata">
<h3>Metadata</h3>
<table class="table table-sm table-hover metadata">
<tbody>
<tr>
<td class="col-md-3">providers</td>
<td class="col-md-9">
<code><a href="../components/ComboBox.html" target="_self" >{
provide: NG_VALUE_ACCESSOR, useExisting: ComboBox, multi: true
}</a></code>
</td>
</tr>
<tr>
<td class="col-md-3">selector</td>
<td class="col-md-9"><code>cds-combo-box, ibm-combo-box</code></td>
</tr>
<tr>
<td class="col-md-3">template</td>
<td class="col-md-9"><pre class="line-numbers"><code class="language-html"><div class="cds--list-box__wrapper">
<label
*ngIf="label"
[for]="id"
class="cds--label"
[ngClass]="{'cds--label--disabled': disabled}">
<ng-container *ngIf="!isTemplate(label)">{{label}}</ng-container>
<ng-template *ngIf="isTemplate(label)" [ngTemplateOutlet]="label"></ng-template>
</label>
<div
#listbox
[ngClass]="{
'cds--multi-select cds--multi-select--filterable': type === 'multi',
'cds--list-box--light': theme === 'light',
'cds--list-box--expanded': open,
'cds--list-box--sm': size === 'sm',
'cds--list-box--md': size === 'md',
'cds--list-box--lg': size === 'lg',
'cds--list-box--disabled': disabled,
'cds--combo-box--warning cds--list-box--warning': warn
}"
class="cds--list-box cds--combo-box"
[attr.data-invalid]="(invalid ? true : null)">
<div
class="cds--list-box__field"
(click)="toggleDropdown()"
(blur)="onBlur()">
<div
*ngIf="type === 'multi' && pills.length > 0"
class="cds--tag cds--tag--filter cds--tag--high-contrast"
[ngClass]="{'cds--tag--disabled': disabled}">
<span class="cds--tag__label">{{ pills.length }}</span>
<button
type="button"
(click)="clearSelected($event)"
(blur)="onBlur()"
(keydown.enter)="clearSelected($event)"
class="cds--tag__close-icon"
tabindex="0"
[title]="clearSelectionsTitle"
[disabled]="disabled"
[attr.aria-label]="clearSelectionAria">
<svg
focusable="false"
preserveAspectRatio="xMidYMid meet"
style="will-change: transform;"
role="img"
xmlns="http://www.w3.org/2000/svg"
width="16"
height="16"
viewBox="0 0 16 16"
aria-hidden="true">
<path d="M12 4.7l-.7-.7L8 7.3 4.7 4l-.7.7L7.3 8 4 11.3l.7.7L8 8.7l3.3 3.3.7-.7L8.7 8z"></path>
</svg>
</button>
</div>
<input
#input
type="text"
autocomplete="off"
role="combobox"
[disabled]="disabled"
(input)="onSearch($event.target.value)"
(blur)="onBlur()"
(keydown.enter)="onSubmit($event)"
[value]="selectedValue"
class="cds--text-input"
[ngClass]="{'cds--text-input--empty': !showClearButton}"
tabindex="0"
[id]="id"
[attr.aria-labelledby]="id"
[attr.aria-expanded]="open"
aria-haspopup="listbox"
[attr.maxlength]="maxLength"
[attr.aria-controls]="open ? view?.listId : null"
[attr.aria-autocomplete]="autocomplete"
[placeholder]="placeholder"/>
<svg
*ngIf="invalid"
cdsIcon="warning--filled"
size="16"
class="cds--list-box__invalid-icon">
</svg>
<svg
*ngIf="!invalid && warn"
cdsIcon="warning--alt--filled"
size="16"
class="cds--list-box__invalid-icon cds--list-box__invalid-icon--warning">
</svg>
<div
*ngIf="showClearButton"
role="button"
class="cds--list-box__selection"
tabindex="0"
[attr.aria-label]="clearSelectionAria"
[title]="clearSelectionTitle"
(keyup.enter)="clearInput($event)"
(click)="clearInput($event)"
(blur)="onBlur()">
<svg cdsIcon="close" size="16"></svg>
</div>
<button
type="button"
role="button"
class="cds--list-box__menu-icon"
tabindex="-1"
[title]="open ? closeMenuAria : openMenuAria"
[attr.aria-label]="open ? closeMenuAria : openMenuAria"
[ngClass]="{'cds--list-box__menu-icon--open': open}">
<svg cdsIcon="chevron--down" size="16"></svg>
</button>
</div>
<div
#dropdownMenu
[ngClass]="{
'cds--list-box--up': this.dropUp !== null && this.dropUp !== undefined ? dropUp : _dropUp
}">
<ng-content *ngIf="open"></ng-content>
</div>
</div>
<div
*ngIf="helperText && !invalid && !warn"
class="cds--form__helper-text"
[ngClass]="{'cds--form__helper-text--disabled': disabled}">
<ng-container *ngIf="!isTemplate(helperText)">{{helperText}}</ng-container>
<ng-template *ngIf="isTemplate(helperText)" [ngTemplateOutlet]="helperText"></ng-template>
</div>
<div *ngIf="invalid" class="cds--form-requirement">
<ng-container *ngIf="!isTemplate(invalidText)">{{ invalidText }}</ng-container>
<ng-template *ngIf="isTemplate(invalidText)" [ngTemplateOutlet]="invalidText"></ng-template>
</div>
<div *ngIf="!invalid && warn" class="cds--form-requirement">
<ng-container *ngIf="!isTemplate(warnText)">{{warnText}}</ng-container>
<ng-template *ngIf="isTemplate(warnText)" [ngTemplateOutlet]="warnText"></ng-template>
</div>
</div>
</code></pre></td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Protected</span>
<a href="#_clearSelectionAria" >_clearSelectionAria</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_clearSelectionsAria" >_clearSelectionsAria</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_clearSelectionsTitle" >_clearSelectionsTitle</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_clearSelectionTitle" >_clearSelectionTitle</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_closeMenuAria" >_closeMenuAria</a>
</li>
<li>
<a href="#_dropUp" >_dropUp</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_openMenuAria" >_openMenuAria</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_placeholder" >_placeholder</a>
</li>
<li>
<span class="modifier">Static</span>
<a href="#comboBoxCount" >comboBoxCount</a>
</li>
<li>
<span class="modifier"></span>
<a href="#display" >display</a>
</li>
<li>
<span class="modifier"></span>
<a href="#dropdownMenu" >dropdownMenu</a>
</li>
<li>
<span class="modifier"></span>
<a href="#hostClass" >hostClass</a>
</li>
<li>
<span class="modifier"></span>
<a href="#input" >input</a>
</li>
<li>
<a href="#keyboardNav" >keyboardNav</a>
</li>
<li>
<span class="modifier"></span>
<a href="#listbox" >listbox</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#noop" >noop</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#onTouchedCallback" >onTouchedCallback</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#open" >open</a>
</li>
<li>
<a href="#outsideClick" >outsideClick</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#pills" >pills</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#propagateChangeCallback" >propagateChangeCallback</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#selectedValue" >selectedValue</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#showClearButton" >showClearButton</a>
</li>
<li>
<span class="modifier"></span>
<a href="#view" >view</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#_appendToBody" >_appendToBody</a>
</li>
<li>
<a href="#_appendToDropdown" >_appendToDropdown</a>
</li>
<li>
<a href="#_keyboardNav" >_keyboardNav</a>
</li>
<li>
<a href="#_noop" >_noop</a>
</li>
<li>
<a href="#_outsideClick" >_outsideClick</a>
</li>
<li>
<a href="#_shouldDropUp" >_shouldDropUp</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#checkForReorder" >checkForReorder</a>
</li>
<li>
<a href="#clearInput" >clearInput</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#clearSelected" >clearSelected</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#closeDropdown" >closeDropdown</a>
</li>
<li>
<span class="modifier"></span>
<a href="#hostkeys" >hostkeys</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#isTemplate" >isTemplate</a>
</li>
<li>
<a href="#ngAfterContentInit" >ngAfterContentInit</a>
</li>
<li>
<a href="#ngAfterViewInit" >ngAfterViewInit</a>
</li>
<li>
<a href="#ngOnChanges" >ngOnChanges</a>
</li>
<li>
<a href="#ngOnDestroy" >ngOnDestroy</a>
</li>
<li>
<a href="#onBlur" >onBlur</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#onSearch" >onSearch</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#onSubmit" >onSubmit</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#openDropdown" >openDropdown</a>
</li>
<li>
<a href="#registerOnChange" >registerOnChange</a>
</li>
<li>
<a href="#registerOnTouched" >registerOnTouched</a>
</li>
<li>
<a href="#setDisabledState" >setDisabledState</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#toggleDropdown" >toggleDropdown</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#updatePills" >updatePills</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#updateSelected" >updateSelected</a>
</li>
<li>
<a href="#writeValue" >writeValue</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Inputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#appendInline" >appendInline</a>
</li>
<li>
<a href="#autocomplete" >autocomplete</a>
</li>
<li>
<a href="#clearSelectionAria" >clearSelectionAria</a>
</li>
<li>
<a href="#clearSelectionsAria" >clearSelectionsAria</a>
</li>
<li>
<a href="#clearSelectionsTitle" >clearSelectionsTitle</a>
</li>
<li>
<a href="#clearSelectionTitle" >clearSelectionTitle</a>
</li>
<li>
<a href="#closeMenuAria" >closeMenuAria</a>
</li>
<li>
<a href="#disabled" >disabled</a>
</li>
<li>
<a href="#dropUp" >dropUp</a>
</li>
<li>
<a href="#helperText" >helperText</a>
</li>
<li>
<a href="#id" >id</a>
</li>
<li>
<a href="#invalid" >invalid</a>
</li>
<li>
<a href="#invalidText" >invalidText</a>
</li>
<li>
<a href="#items" >items</a>
</li>
<li>
<a href="#itemValueKey" >itemValueKey</a>
</li>
<li>
<a href="#label" >label</a>
</li>
<li>
<a href="#maxLength" >maxLength</a>
</li>
<li>
<a href="#openMenuAria" >openMenuAria</a>
</li>
<li>
<a href="#placeholder" >placeholder</a>
</li>
<li>
<a href="#selectionFeedback" >selectionFeedback</a>
</li>
<li>
<a href="#size" >size</a>
</li>
<li>
<a href="#theme" class="deprecated-name">theme</a>
</li>
<li>
<a href="#type" >type</a>
</li>
<li>
<a href="#warn" >warn</a>
</li>
<li>
<a href="#warnText" >warnText</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Outputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#clear" >clear</a>
</li>
<li>
<a href="#close" >close</a>
</li>
<li>
<a href="#search" >search</a>
</li>
<li>
<a href="#selected" >selected</a>
</li>
<li>
<a href="#submit" >submit</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>HostBindings</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#class.cds--list-box__wrapper" >class.cds--list-box__wrapper</a>
</li>
<li>
<a href="#style.display" >style.display</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>HostListeners</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#keydown" >keydown</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#placeholder" >placeholder</a>
</li>
<li>
<a href="#openMenuAria" >openMenuAria</a>
</li>
<li>
<a href="#closeMenuAria" >closeMenuAria</a>
</li>
<li>
<a href="#clearSelectionsTitle" >clearSelectionsTitle</a>
</li>
<li>
<a href="#clearSelectionsAria" >clearSelectionsAria</a>
</li>
<li>
<a href="#clearSelectionTitle" >clearSelectionTitle</a>
</li>
<li>
<a href="#clearSelectionAria" >clearSelectionAria</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(elementRef: ElementRef, dropdownService: <a href="../injectables/DropdownService.html" target="_self">DropdownService</a>, i18n: <a href="../injectables/I18n.html" target="_self">I18n</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="442" class="link-to-prism">src/combobox/combobox.component.ts:442</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Creates an instance of ComboBox.</p>
</div>
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>elementRef</td>
<td>
<code>ElementRef</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>dropdownService</td>
<td>
<code><a href="../injectables/DropdownService.html" target="_self" >DropdownService</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>i18n</td>
<td>
<code><a href="../injectables/I18n.html" target="_self" >I18n</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-inputs">
<h3 id="inputs">Inputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="appendInline"></a>
<b>appendInline</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>null</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="311" class="link-to-prism">src/combobox/combobox.component.ts:311</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>set to <code>true</code> to place the dropdown view inline with the component</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="autocomplete"></a>
<b>autocomplete</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"list"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="347" class="link-to-prism">src/combobox/combobox.component.ts:347</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Specify aria-autocomplete attribute of text input.
"list", is the expected value for a combobox that invokes a drop-down list</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="clearSelectionAria"></a>
<b>clearSelectionAria</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | Observable</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="252" class="link-to-prism">src/combobox/combobox.component.ts:252</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Value to display for accessibility purposes on the clear the selected item icon, when single is selected</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="clearSelectionsAria"></a>
<b>clearSelectionsAria</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | Observable</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="232" class="link-to-prism">src/combobox/combobox.component.ts:232</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Value to display for accessibility purposes to clear selections, when multi is selected</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="clearSelectionsTitle"></a>
<b>clearSelectionsTitle</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | Observable</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="222" class="link-to-prism">src/combobox/combobox.component.ts:222</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Value to display on the clear selections icon, when multi is selected</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="clearSelectionTitle"></a>
<b>clearSelectionTitle</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | Observable</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="242" class="link-to-prism">src/combobox/combobox.component.ts:242</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Value to display on the clear the selected item icon, when single is selected</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="closeMenuAria"></a>
<b>closeMenuAria</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | Observable</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="212" class="link-to-prism">src/combobox/combobox.component.ts:212</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Value to display for accessibility purposes on the combobox control menu when opened</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="disabled"></a>
<b>disabled</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="355" class="link-to-prism">src/combobox/combobox.component.ts:355</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to disable combobox.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dropUp"></a>
<b>dropUp</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="351" class="link-to-prism">src/combobox/combobox.component.ts:351</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Overrides the automatic dropUp.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="helperText"></a>
<b>helperText</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | TemplateRef<any></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="307" class="link-to-prism">src/combobox/combobox.component.ts:307</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Sets the optional helper text.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="id"></a>
<b>id</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>`dropdown-${ComboBox.comboBoxCount++}`</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="260" class="link-to-prism">src/combobox/combobox.component.ts:260</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="invalid"></a>
<b>invalid</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="315" class="link-to-prism">src/combobox/combobox.component.ts:315</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set to <code>true</code> to show the invalid state.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="invalidText"></a>
<b>invalidText</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | TemplateRef<any></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="319" class="link-to-prism">src/combobox/combobox.component.ts:319</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Value displayed if combobox is in an invalid state.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="items"></a>
<b>items</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/ListItem.html" target="_self" >Array<ListItem></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="287" class="link-to-prism">src/combobox/combobox.component.ts:287</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of items to fill the content with.</p>
<p><strong>Example:</strong></p>
<div><pre class="line-numbers"><code class="language-javascript">items = [
{
content: "Abacus",
selected: false
},
{
content: "Byte",
selected: false,
},
{
content: "Computer",
selected: false
},
{
content: "Digital",
selected: false
}
];</code></pre></div></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>