carbon-components-angular
Version:
Next generation components
1,264 lines (1,114 loc) • 149 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">
<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 component">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Components</li>
<li class="breadcrumb-item"
>
DropdownList</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/dropdown/list/dropdown-list.component.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<b>Example :</b><div><pre class="line-numbers"><code class="language-html"><cds-dropdown-list [items]="listItems"></cds-dropdown-list></code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">listItems = [
{
content: "item one",
selected: false
},
{
content: "item two",
selected: false,
},
{
content: "item three",
selected: false
},
{
content: "item four",
selected: false
}
];</code></pre></div>
</p>
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code><a href="../directives/AbstractDropdownView.html" target="_self" >AbstractDropdownView</a></code>
<code>AfterViewInit</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>{
provide: AbstractDropdownView, useExisting: DropdownList
}</code>
</td>
</tr>
<tr>
<td class="col-md-3">selector</td>
<td class="col-md-9"><code>cds-dropdown-list, ibm-dropdown-list</code></td>
</tr>
<tr>
<td class="col-md-3">template</td>
<td class="col-md-9"><pre class="line-numbers"><code class="language-html"><ul
#list
[id]="listId"
role="listbox"
class="cds--list-box__menu cds--multi-select"
(scroll)="emitScroll($event)"
(keydown)="navigateList($event)"
tabindex="0"
[attr.aria-label]="ariaLabel"
[attr.aria-activedescendant]="highlightedItem">
<li
role="option"
*ngFor="let item of displayItems; let i = index"
(click)="doClick($event, item)"
class="cds--list-box__menu-item"
[attr.aria-selected]="item.selected"
[id]="getItemId(i)"
[attr.tabindex]="highlightedItem === getItemId(i) ? 0 : null"
[attr.title]=" showTitles ? item.content : null"
[attr.disabled]="item.disabled ? true : null"
[ngClass]="{
'cds--list-box__menu-item--active': item.selected,
'cds--list-box__menu-item--highlighted': highlightedItem === getItemId(i)
}">
<div
#listItem
tabindex="-1"
class="cds--list-box__menu-item__option">
<div
*ngIf="!listTpl && type === 'multi'"
class="cds--form-item cds--checkbox-wrapper">
<label
[attr.data-contained-checkbox-state]="item.selected"
class="cds--checkbox-label">
<input
class="cds--checkbox"
type="checkbox"
[checked]="item.selected"
[disabled]="item.disabled"
tabindex="-1">
<span class="cds--checkbox-appearance"></span>
<span class="cds--checkbox-label-text">{{item.content}}</span>
</label>
</div>
<ng-container *ngIf="!listTpl && type === 'single'">{{item.content}}</ng-container>
<svg
*ngIf="!listTpl && type === 'single'"
cdsIcon="checkmark"
size="16"
class="cds--list-box__menu-item__selected-icon">
</svg>
<ng-template
*ngIf="listTpl"
[ngTemplateOutletContext]="{item: item}"
[ngTemplateOutlet]="listTpl">
</ng-template>
</div>
</li>
</ul></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="#_items" >_items</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_itemsReady" >_itemsReady</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_itemsSubscription" >_itemsSubscription</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#_originalItems" >_originalItems</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#displayItems" >displayItems</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#elementRef" >elementRef</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#focusJump" >focusJump</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#highlightedItem" >highlightedItem</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#index" >index</a>
</li>
<li>
<span class="modifier"></span>
<a href="#list" >list</a>
</li>
<li>
<span class="modifier">Static</span>
<a href="#listCount" >listCount</a>
</li>
<li>
<span class="modifier"></span>
<span class="modifier">Protected</span>
<a href="#listElementList" >listElementList</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#listId" >listId</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#size" >size</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="#doClick" >doClick</a>
</li>
<li>
<a href="#doEmitSelect" >doEmitSelect</a>
</li>
<li>
<a href="#emitScroll" >emitScroll</a>
</li>
<li>
<a href="#filterBy" >filterBy</a>
</li>
<li>
<a href="#getCurrentElement" >getCurrentElement</a>
</li>
<li>
<a href="#getCurrentItem" >getCurrentItem</a>
</li>
<li>
<a href="#getItemId" >getItemId</a>
</li>
<li>
<a href="#getListItems" >getListItems</a>
</li>
<li>
<a href="#getNextElement" >getNextElement</a>
</li>
<li>
<a href="#getNextItem" >getNextItem</a>
</li>
<li>
<a href="#getPrevElement" >getPrevElement</a>
</li>
<li>
<a href="#getPrevItem" >getPrevItem</a>
</li>
<li>
<a href="#getSelected" >getSelected</a>
</li>
<li>
<a href="#hasNextElement" >hasNextElement</a>
</li>
<li>
<a href="#hasPrevElement" >hasPrevElement</a>
</li>
<li>
<a href="#initFocus" >initFocus</a>
</li>
<li>
<a href="#navigateList" >navigateList</a>
</li>
<li>
<a href="#ngAfterViewInit" >ngAfterViewInit</a>
</li>
<li>
<a href="#ngOnDestroy" >ngOnDestroy</a>
</li>
<li>
<a href="#onItemBlur" >onItemBlur</a>
</li>
<li>
<a href="#onItemFocus" >onItemFocus</a>
</li>
<li>
<a href="#onItemsReady" >onItemsReady</a>
</li>
<li>
<a href="#propagateSelected" >propagateSelected</a>
</li>
<li>
<a href="#reorderSelected" >reorderSelected</a>
</li>
<li>
<a href="#setupFocusObservable" >setupFocusObservable</a>
</li>
<li>
<a href="#updateIndex" >updateIndex</a>
</li>
<li>
<a href="#updateList" >updateList</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="#ariaLabel" >ariaLabel</a>
</li>
<li>
<a href="#items" >items</a>
</li>
<li>
<a href="#listTpl" >listTpl</a>
</li>
<li>
<a href="#showTitles" >showTitles</a>
</li>
<li>
<a href="#type" >type</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="#blurIntent" >blurIntent</a>
</li>
<li>
<a href="#scroll" >scroll</a>
</li>
<li>
<a href="#select" >select</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="#items" >items</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, i18n: <a href="../injectables/I18n.html" target="_self">I18n</a>, appRef: ApplicationRef)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="223" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:223</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Creates an instance of <code>DropdownList</code>.</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>i18n</td>
<td>
<code><a href="../injectables/I18n.html" target="_self" >I18n</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>appRef</td>
<td>
<code>ApplicationRef</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="ariaLabel"></a>
<b>ariaLabel</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.i18n.get().DROPDOWN_LIST.LABEL</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="121" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:121</a></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>Array | Observable</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="125" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:125</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>The list items belonging to the <code>DropdownList</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="listTpl"></a>
<b>listTpl</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>string | TemplateRef<any></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="150" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:150</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Template to bind to items in the <code>DropdownList</code> (optional).</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="showTitles"></a>
<b>showTitles</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>true</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="182" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:182</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Defines whether to show title attribute or not</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="type"></a>
<b>type</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"single" | "multi"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"single"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="177" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:177</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Defines whether or not the <code>DropdownList</code> supports selecting multiple items as opposed to single
item selection.</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-outputs">
<h3 id="outputs">Outputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="blurIntent"></a>
<b>blurIntent</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>EventEmitter</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="168" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:168</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Event to suggest a blur on the view.
Emits <em>after</em> the first/last item has been focused.
ex.
ArrowUp -> focus first item
ArrowUp -> emit event</p>
<p>When this event fires focus should be placed on some element outside of the list - blurring the list as a result</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="scroll"></a>
<b>scroll</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/ScrollCustomEvent.html" target="_self" >EventEmitter<ScrollCustomEvent></a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="158" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:158</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Event to emit scroll event of a list within the <code>DropdownList</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="select"></a>
<b>select</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>EventEmitter<literal type | []></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="154" class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:154</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Event to emit selection of a list item within the <code>DropdownList</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="doClick"></a>
<span class="name">
<span ><b>doClick</b></span>
<a href="#doClick"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>doClick(event, item)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="552"
class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:552</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Emits the selected item or items after a mouse click event has occurred.</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>event</td>
<td>
No
</td>
</tr>
<tr>
<td>item</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="doEmitSelect"></a>
<span class="name">
<span ><b>doEmitSelect</b></span>
<a href="#doEmitSelect"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>doEmitSelect(isUpdate)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="254"
class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:254</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>isUpdate</td>
<td>
No
</td>
<td>
<code>true</code>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="emitScroll"></a>
<span class="name">
<span ><b>emitScroll</b></span>
<a href="#emitScroll"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>emitScroll(event)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="587"
class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:587</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Emits the scroll event of the options list</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>event</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="filterBy"></a>
<span class="name">
<span ><b>filterBy</b></span>
<a href="#filterBy"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>filterBy(query: <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">
<div class="io-line">Defined in <a href="" data-line="284"
class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:284</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Filters the items being displayed in the DOM list.</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>query</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
<td>
<code>""</code>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getCurrentElement"></a>
<span class="name">
<span ><b>getCurrentElement</b></span>
<a href="#getCurrentElement"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getCurrentElement()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="415"
class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:415</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Returns the <code>HTMLElement</code> for the item that is selected within the <code>DropdownList</code>.</p>
</div>
<div class="io-description">
<b>Returns : </b> <code>HTMLElement</code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getCurrentItem"></a>
<span class="name">
<span ><b>getCurrentItem</b></span>
<a href="#getCurrentItem"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getCurrentItem()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="405"
class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:405</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Returns the <code>ListItem</code> that is selected within <code>DropdownList</code>.</p>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../interfaces/ListItem.html" target="_self" >ListItem</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getItemId"></a>
<span class="name">
<span ><b>getItemId</b></span>
<a href="#getItemId"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getItemId(index: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="266"
class="link-to-prism">src/dropdown/list/dropdown-list.component.ts:266</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>index</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">