Class IgxSelectComponent

Ignite UI for Angular Select - Documentation

The igxSelect provides an input with dropdown list allowing selection of a single item.

Example:

<igx-select #select1 [placeholder]="'Pick One'">
<label igxLabel>Select Label</label>
<igx-select-item *ngFor="let item of items" [value]="item.field">
{{ item.field }}
</igx-select-item>
</igx-select>

Hierarchy

Hierarchy (view full)

Implements

  • IgxSelectBase
  • ControlValueAccessor
  • AfterContentInit
  • OnInit
  • AfterViewInit
  • OnDestroy
  • EditorProvider
  • AfterContentChecked

Constructors

Properties

closed: EventEmitter<IBaseEventArgs> = ...

Emitted after the dropdown is closed

<igx-select (closed)='handleClosed($event)'></igx-select>
closing: EventEmitter<IBaseCancelableBrowserEventArgs> = ...

Emitted before the dropdown is closed

<igx-select (closing)='handleClosing($event)'></igx-select>
densityChanged: EventEmitter<IDensityChangedEventArgs> = ...
disabled: boolean = false

Disables the component.

<igx-select [disabled]="'true'"></igx-select>
footerTemplate: TemplateRef<any> = null

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

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

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

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.select.headerTemplate = myCustomTemplate;
<!-- Set in markup -->
<igx-select #select>
...
<ng-template igxSelectHeader>
<div class="select__header">
This is a custom header
</div>
</ng-template>
</igx-select>
labelledBy: string

Sets aria-labelledby attribute value.

<igx-drop-down [labelledby]="labelId"></igx-drop-down>
opened: EventEmitter<IBaseEventArgs> = ...

Emitted after the dropdown is opened

<igx-select (opened)='handleOpened($event)'></igx-select>
opening: EventEmitter<IBaseCancelableBrowserEventArgs> = ...

Emitted before the dropdown is opened

<igx-select opening='handleOpening($event)'></igx-select>
overlaySettings: OverlaySettings

Sets custom OverlaySettings IgxSelectComponent.

<igx-select [overlaySettings] = "customOverlaySettings"></igx-select>
placeholder: any

Sets input placeholder.

selectionChanging: EventEmitter<ISelectionEventArgs> = ...

Emitted when item selection is changing, before the selection completes

<igx-drop-down (selectionChanging)='handleSelection()'></igx-drop-down>
toggleIconTemplate: TemplateRef<any> = null

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

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

Accessors

Methods

  • Sets the --component-size CSS variable based on the value of Display Density

    Returns "var(--ig-size, var(--ig-size-small))" | "var(--ig-size, var(--ig-size-medium))" | "var(--ig-size, var(--ig-size-large))"