IgxComboBaseDirective

new IgxComboBaseDirective(): IgxComboBaseDirective

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1003

Returns IgxComboBaseDirective

The custom template, if any, that should be used when rendering the ADD BUTTON in the combo drop down

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.addItemTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboAddItem>
         <button type="button" igxButton="contained" class="combo__add-button">
             Click to add item
         </button>
     </ng-template>
 </igx-combo>
addItemTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:687

Emitted when an item is being added to the data collection

<igx-combo (addition)='handleAdditionEvent($event)'></igx-combo>
addition: EventEmitter<IComboItemAdditionEvent>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:553

Controls whether custom values can be added to the collection

// get
let comboAllowsCustomValues = this.combo.allowCustomValues;
<!--set-->
<igx-combo [allowCustomValues]='true'></igx-combo>
allowCustomValues: boolean = false

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:230

Sets aria-labelledby attribute value.

<igx-combo [ariaLabelledBy]="'label1'">
ariaLabelledBy: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:444

The custom template, if any, that should be used when rendering the combo CLEAR button

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.clearIconTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboClearIcon>
         <igx-icon>clear</igx-icon>
     </ng-template>
 </igx-combo>
clearIconTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:752

Emitted after the dropdown is closed

<igx-combo (closed)='handleClosed($event)'></igx-combo>
closed: EventEmitter<IBaseEventArgs>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:543

Emitted before the dropdown is closed

<igx-combo (closing)='handleClosing($event)'></igx-combo>
closing: EventEmitter<IBaseCancelableBrowserEventArgs>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:533

Emitted when new chunk of data is loaded from the virtualization

<igx-combo (dataPreLoad)='handleDataPreloadEvent($event)'></igx-combo>
dataPreLoad: EventEmitter<IForOfState>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:573

Disables the clear button. The default is false.

// get
let myComboDisableClear = this.combo.disableClear;
<!--set-->
<igx-combo [disableClear]="true"></igx-combo>
disableClear: boolean = false

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:473

Disables the combo. The default is false.

<igx-combo [disabled]="'true'">
disabled: boolean = false

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:457

document: Document

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:117

dropdown: IgxComboDropDownComponent

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:999

The custom template, if any, that should be used when rendering the ADD BUTTON in the combo drop down

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.emptyTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboEmpty>
         <div class="combo--empty">
             There are no items to display
         </div>
     </ng-template>
 </igx-combo>
emptyTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:710

Gets/Sets the custom filtering function of the combo.

filterFunction: object

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:435

Example

<igx-comb #combo [data]="localData" [filterFunction]="filterFunction"></igx-combo>

The custom template, if any, that should be used when rendering the FOOTER for the combo items list

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.footerTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboFooter>
         <div class="combo__footer">
             This is a custom footer
         </div>
     </ng-template>
 </igx-combo>
footerTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:643

The custom template, if any, that should be used when rendering HEADER ITEMS for groups in the combo list

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.headerItemTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboHeaderItem let-item let-key="groupKey">
         <div class="custom-item--group">Group header for {{ item[key] }}</div>
     </ng-template>
 </igx-combo>
headerItemTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:664

The custom template, if any, that should be used when rendering the HEADER for the combo items list

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.headerTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboHeader>
         <div class="combo__header">
             This is a custom header
         </div>
     </ng-template>
 </igx-combo>
headerTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:620

Configures the drop down list width

// get
let myComboItemsWidth = this.combo.itemsWidth;
<!--set-->
<igx-combo [itemsWidth] = '"180px"'></igx-combo>
itemsWidth: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:300

The custom template, if any, that should be used when rendering ITEMS in the combo list

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.itemTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboItem let-item let-key="valueKey">
         <div class="custom-item">
             <div class="custom-item__name">{{ item[key] }}</div>
             <div class="custom-item__cost">{{ item.cost }}</div>
         </div>
     </ng-template>
 </igx-combo>
itemTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:597

Emitted after the dropdown is opened

<igx-combo (opened)='handleOpened($event)'></igx-combo>
opened: EventEmitter<IBaseEventArgs>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:523

Emitted before the dropdown is opened

<igx-combo opening='handleOpening($event)'></igx-combo>
opening: EventEmitter<IBaseCancelableBrowserEventArgs>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:513

Set custom overlay settings that control how the combo's list of items is displayed. Set:

<igx-combo [overlaySettings]="customOverlaySettings"></igx-combo>
const customSettings = { positionStrategy: { settings: { target: myTarget } } };
 combo.overlaySettings = customSettings;

Get any custom overlay settings used by the combo:

const comboOverlaySettings: OverlaySettings = myCombo.overlaySettings;
overlaySettings: OverlaySettings = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:166

Defines the placeholder value for the combo value field

// get
let myComboPlaceholder = this.combo.placeholder;
<!--set-->
<igx-combo [placeholder]='newPlaceHolder'></igx-combo>
placeholder: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:316

Emitted when the value of the search input changes (e.g. typing, pasting, clear, etc.)

<igx-combo (searchInputUpdate)='handleSearchInputEvent($event)'></igx-combo>
searchInputUpdate: EventEmitter<IComboSearchInputEventArgs>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:563

selectionChanged: EventEmitter<any>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1001

selectionChanging: EventEmitter<any>

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1000

Defines whether the caseSensitive icon should be shown in the search input

// get
let myComboShowSearchCaseIcon = this.combo.showSearchCaseIcon;
<!--set-->
<igx-combo [showSearchCaseIcon]='true'></igx-combo>
showSearchCaseIcon: boolean = false

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:136

The custom template, if any, that should be used when rendering the combo TOGGLE(open/close) button

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.combo.toggleIconTemplate = myCustomTemplate;
<!-- Set in markup -->
 <igx-combo #combo>
     ...
     <ng-template igxComboToggleIcon let-collapsed>
         <igx-icon>{{ collapsed ? 'remove_circle' : 'remove_circle_outline'}}</igx-icon>
     </ng-template>
 </igx-combo>
toggleIconTemplate: TemplateRef<any> = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:731

Determines which column in the data source is used to determine the value.

// get
let myComboValueKey = this.combo.valueKey;
<!--set-->
<igx-combo [valueKey]='myKey'></igx-combo>
valueKey: string = null

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:354

Sets the style width of the element

// get
let myComboWidth = this.combo.width;
<!--set-->
<igx-combo [width]='250px'></igx-combo>
width: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:214

data: any[]

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:327, projects/igniteui-angular/combo/src/combo/combo.common.ts:330

disableFiltering: boolean

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:142, projects/igniteui-angular/combo/src/combo/combo.common.ts:145

displayKey: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:357, projects/igniteui-angular/combo/src/combo/combo.common.ts:378

filteredData: any[]

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1422, projects/igniteui-angular/combo/src/combo/combo.common.ts:1423

filteringOptions: IComboFilteringOptions

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:960, projects/igniteui-angular/combo/src/combo/combo.common.ts:963

groupKey: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:391, projects/igniteui-angular/combo/src/combo/combo.common.ts:403

groupSortingDirection: SortingDirection

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:419, projects/igniteui-angular/combo/src/combo/combo.common.ts:422

id: string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:183, projects/igniteui-angular/combo/src/combo/combo.common.ts:187

itemHeight: number

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:278, projects/igniteui-angular/combo/src/combo/combo.common.ts:282

itemsMaxHeight: number

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:246, projects/igniteui-angular/combo/src/combo/combo.common.ts:253

resourceStrings: IComboResourceStrings

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:498, projects/igniteui-angular/combo/src/combo/combo.common.ts:501

totalItemCount: number

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:909, projects/igniteui-angular/combo/src/combo/combo.common.ts:920

type: IgxInputGroupType

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:483, projects/igniteui-angular/combo/src/combo/combo.common.ts:487

valid: IgxInputState

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:826, projects/igniteui-angular/combo/src/combo/combo.common.ts:838

virtualizationState: IForOfState

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:875, projects/igniteui-angular/combo/src/combo/combo.common.ts:886

Gets drop down state.

let state = this.combo.collapsed;
get collapsed(): boolean

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:897

Returns boolean

The text displayed in the combo input

// get
let comboDisplayValue = this.combo.displayValue;
get displayValue(): string

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:863

Returns string

Get current selection state

get selection(): any[]

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1145

Returns any[]

The value of the combo

// get
let comboValue = this.combo.value;
get value(): any[]

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:851

Returns any[]

A method that closes the combo.

<button type="button" (click)="combo.close()">Close Combo</button>
<igx-combo #combo></igx-combo>
close(): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1126

Returns void

deselect(args: tuple | [items, event]): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1432

Parameters

  • args: tuple | [items, event]

Returns void

focusSearchInput(opening: boolean): any

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1427

Parameters

  • opening: boolean

Returns any

handleOpened(): any

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1425

Returns any

A callback method that is invoked immediately after the default change detector has completed one change-check cycle for a component's view.

ngAfterViewChecked(): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1009

Returns void

onArrowDown(event: Event): any

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1426

Parameters

  • event: Event

Returns any

A method that opens the combo.

<button type="button" (click)="combo.open()">Open Combo</button>
<igx-combo #combo></igx-combo>
open(): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1108

Returns void

select(newItem: any): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1429

Parameters

  • newItem: any

Returns void

A method that opens/closes the combo.

<button type="button" (click)="combo.toggle()">Toggle Combo</button>
<igx-combo #combo></igx-combo>
toggle(): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1088

Returns void

Triggers change detection on the combo view

triggerCheck(): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1133

Returns void

writeValue(value: any): void

Defined in projects/igniteui-angular/combo/src/combo/combo.common.ts:1434

Parameters

  • value: any

Returns void