An abstract class defining a drop-down item: With properties / styles for selection, highlight, height Bindable property for passing data (value: any) Parent component (has to be used under a parent with type IDropDownBase) Method for handling click on Host()

Constructors

Section titled "Constructors"

IgxDropDownItemBaseDirective 

new IgxDropDownItemBaseDirective(): IgxDropDownItemBaseDirective

Returns IgxDropDownItemBaseDirective

Properties

Section titled "Properties"

id

Section titled "id"

Sets/gets the id of the item.

<igx-drop-down-item [id] = 'igx-drop-down-item-0'></igx-drop-down-item>
let itemId =  this.item.id;
id: string

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:38

isHeader

Section titled "isHeader"

Sets/gets if the given item is header

// get
 let mySelectedItem = this.dropdown.selectedItem;
 let isMyItemHeader = mySelectedItem.isHeader;
<!--set-->
 <igx-drop-down-item *ngFor="let item of items">
     <div *ngIf="items.indexOf(item) === 5; then item.isHeader = true">
         {{item.field}}
     </div>
 </igx-drop-down-item>
isHeader: boolean

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:183

role

Section titled "role"

Gets/sets the role attribute of the item. Default is 'option'.

<igx-drop-down-item [role]="customRole"></igx-drop-down-item>
role: string = 'option'

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:223

value

Section titled "value"

Gets/sets the value of the item if the item is databound

// usage in IgxDropDownItemComponent
// get
let mySelectedItemValue = this.dropdown.selectedItem.value;

// set
let mySelectedItem = this.dropdown.selectedItem;
mySelectedItem.value = { id: 123, name: 'Example Name' }

// usage in IgxComboItemComponent
// get
let myComboItemValue = this.combo.items[0].value;
value: any

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:95

Accessors

Section titled "Accessors"

ariaLabel

Section titled "ariaLabel" 
get ariaLabel(): string

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:42

Returns string 

set ariaLabel(value: string): void

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:46

Parameters

  • value: string

Returns void

disabled

Section titled "disabled"

Sets/gets if the given item is disabled

// get
 let mySelectedItem = this.dropdown.selectedItem;
 let myItemIsDisabled = mySelectedItem.disabled;
<igx-drop-down-item *ngFor="let item of items" disabled={{!item.disabled}}>
     <div>
         {{item.field}}
     </div>
 </igx-drop-down-item>

NOTE: Drop-down items inside of a disabled drop down group will always count as disabled

 
get disabled(): boolean

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:206

Returns boolean 

set disabled(value: boolean): void

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:210

Parameters

  • value: boolean

Returns void

focused

Section titled "focused"

Sets/gets if the given item is focused

let mySelectedItem = this.dropdown.selectedItem;
 let isMyItemFocused = mySelectedItem.focused;
get focused(): boolean

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:147

Returns boolean 

<igx-drop-down-item *ngFor="let item of items" focused={{!item.focused}}>
     <div>
         {{item.field}}
     </div>
 </igx-drop-down-item>
set focused(value: boolean): void

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:160

Parameters

  • value: boolean

Returns void

index

Section titled "index"

The data index of the dropdown item.

// get the data index of the selected dropdown item
let selectedItemIndex = this.dropdown.selectedItem.index
get index(): number

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:66

Returns number 

set index(value: number): void

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:73

Parameters

  • value: number

Returns void

selected

Section titled "selected"

Sets/Gets if the item is the currently selected one in the dropdown

let mySelectedItem = this.dropdown.selectedItem;
 let isMyItemSelected = mySelectedItem.selected; // true

Two-way data binding

<igx-drop-down-item [(selected)]='model.isSelected'></igx-drop-down-item>
get selected(): boolean

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:121

Returns boolean 

set selected(value: boolean): void

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:125

Parameters

  • value: boolean

Returns void

Methods

Section titled "Methods"

ngDoCheck

Section titled "ngDoCheck"

A callback method that performs change-detection, invoked after the default change-detector has checked the directive's input bindings in the parent template. See KeyValueDiffers and IterableDiffers for implementing custom change checking for collections.

 
ngDoCheck(): void

Defined in projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts:284

Returns void