Class IgxSelectComponent

Ignite UI for Angular Select - ヘルプ

igxSelect は、単一項目の選択ができるドロップダウン リストの入力を提供します。

例:

<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 (view full)

実装

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

コンストラクター

プロパティ

closed: EventEmitter<IBaseEventArgs> = ...

ドロップダウンが閉じた後に発生されます。

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

ドロップダウンが閉じられる前に発生されます。

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

コンポーネントを無効にします。

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

カスタム テンプレートがある場合は、select items リストのための FOOTER の描画に使用されます。

// 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

カスタム テンプレートがある場合は、select items リストのための HEADER の描画に使用されます。

// 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

aria-labelledby 属性値を設定します。

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

ドロップダウンが開かれた後に発生されます。

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

ドロップダウンが開かれる前に発生されます。

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

カスタム OverlaySettings IgxSelectComponent を設定します。

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

入力プレースホルダーを設定します。

selectionChanging: EventEmitter<ISelectionEventArgs> = ...

選択を完了する前に項目選択が変更されるときに発生されます。

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

カスタム テンプレートがある場合、選択 TOGGLE (開く/閉じる) ボタンを描画するために使用されるカスタム テンプレートです。

// 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>

アクセサー

  • get displayDensity(): DisplayDensity
  • コンポーネントのテーマを返します。デフォルトのテーマは comfortable です。 利用可能なオプションは comfortablecosy、または compact です。

    let componentTheme = this.component.displayDensity;
    

    非推奨

    バージョン 16.1.0 以降。 --ig-size CSS カスタム プロパティを使用してください。

    参照

    アップデート ガイド

    返却 DisplayDensity

  • set displayDensity(val): void
  • コンポーネントのテーマを設定します。

    パラメーター

    返却 void

  • get headers(): IgxDropDownItemBaseDirective[]
  • すべてのヘッダー項目を取得します。

    let myDropDownHeaderItems = this.dropdown.headers;
    

    返却 IgxDropDownItemBaseDirective[]

  • get items(): IgxDropDownItemBaseDirective[]
  • すべてのヘッダー以外の項目を取得します。

    let myDropDownItems = this.dropdown.items;
    

    返却 IgxDropDownItemBaseDirective[]

メソッド

  • 表示密度の値に基づいて --component-size CSS 変数を設定します。

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