Combo (コンボ) コンポーネントの機能
Angular Combo は、ローカル データへのバインド、ユーザーの入力に応じたオプションのフィルタリング、データ フィールドによるグループ化に対応し、無効にすることもできます。
Combo は、リモート サービスからデータをチャンク単位で読み込んだり、カスタム値を受け入れたり、カスタム オーバーレイ設定でリストを表示したりすることもできます。
ライブ デモ
機能
データ バインディング
次のスニペットは、data プロパティを使用して Angular Combo を米国の州のローカル リストにバインドし、各州のコードを保持して州名を表示します。Combo が各項目から読み取るキーについては、Combo の概要トピックのデータ バインディングを参照してください。
import { usStates } from './states-data';
export class ComboDataBindingComponent {
// Items such as { id: 'CT', name: 'Connecticut', region: 'New England' }
public usStates = usStates;
}
<igx-combo [data]="usStates" valueKey="id" displayKey="name"></igx-combo>
リモート バインディング
Combo は、リモート サービスからデータをチャンク単位で読み込めます。ユーザーがスクロールした位置の項目を dataPreLoad イベントで要求し、サービスはそれらの項目のみを返します。次のサンプルは、ユーザーのスクロールや検索に合わせて、リモート サービスから製品を読み込みます。
リモート サービスの定義
リモート サービスは、サーバーから項目をオンデマンドで読み込みます。Combo は virtualizationState プロパティを公開しており、読み込む最初の項目のインデックスと読み込む項目数を保持します。サーバー上のすべての項目に合わせてスクロール バーのサイズを設定するには、totalItemCount プロパティに項目の合計数を設定します。
次のサービスには、Combo の状態と検索テキストからリクエストを作成し、読み込んだ項目を Observable で発行する getData() メソッドがあります。
import { HttpClient } from '@angular/common/http';
import { Injectable, inject } from '@angular/core';
import { IForOfState } from 'igniteui-angular/directives';
// import { IForOfState } from '@infragistics/igniteui-angular/directives'; for licensed package
import { BehaviorSubject } from 'rxjs';
@Injectable()
export class RemoteNWindService {
private http = inject(HttpClient);
private url = 'https://services.odata.org/V4/Northwind/Northwind.svc/Products';
public remoteData = new BehaviorSubject<any[]>([]);
public getData(state: IForOfState, searchText: string, cb?: (data: any) => void) {
return this.http.get(this.buildUrl(state, searchText)).subscribe((data: any) => {
this.remoteData.next(data.value);
cb?.(data);
});
}
// Requests the chunk of items the Combo shows, and the total count of the matching items.
private buildUrl(state: IForOfState, searchText: string): string {
let query = `?$skip=${state.startIndex}&$top=${state.chunkSize}&$count=true`;
if (searchText) {
// Double the apostrophes for OData, then encode the text for the URL.
const text = encodeURIComponent(searchText.replace(/'/g, "''"));
query += `&$filter=contains(ProductName, '${text}')`;
}
return `${this.url}${query}`;
}
}
ComboBox をリモート サービスにバインド
サービスの Observable を async パイプで Combo にバインドし、Combo が dataPreLoad を発生させたとき、または検索テキストが変更されたときに、新しい項目のチャンクを要求します。
<igx-combo #remoteCombo
[data]="rData | async"
valueKey="ProductID"
displayKey="ProductName"
(dataPreLoad)="onDataPreLoad()"
(searchInputUpdate)="onSearchInputUpdate($event)">
<label igxLabel>Products</label>
</igx-combo>
// The size of the first chunk, requested before the Combo reports how many items it shows.
const FIRST_CHUNK_SIZE = 10;
// The component lists RemoteNWindService in its providers, and the application
// providers include provideHttpClient(), which the service needs.
export class ComboRemoteComponent implements OnInit {
@ViewChild('remoteCombo', { static: true })
public remoteCombo: IgxComboComponent;
private remoteService = inject(RemoteNWindService);
public rData = this.remoteService.remoteData;
private searchText = '';
public ngOnInit() {
this.loadChunk({ startIndex: 0, chunkSize: FIRST_CHUNK_SIZE });
}
// The Combo asks for the next chunk while the user scrolls.
public onDataPreLoad() {
this.loadChunk(this.remoteCombo.virtualizationState);
}
// The server filters the items: request the first chunk of the matching ones.
public onSearchInputUpdate(event: IComboSearchInputEventArgs) {
this.searchText = event.searchText;
this.loadChunk({ startIndex: 0, chunkSize: FIRST_CHUNK_SIZE });
}
private loadChunk(state: IForOfState) {
this.remoteService.getData(state, this.searchText, (data) => {
// The total count sizes the scrollbar for all the items, not only the loaded chunk.
this.remoteCombo.totalItemCount = data['@odata.count'];
});
}
}
選択の処理
チャンク単位で読み込まれるリモート データに Combo をバインドし、データ項目がオブジェクトである場合は、valueKey プロパティを設定します。設定しないと、Combo トピックで説明しているように、Combo は選択された項目と読み込まれた項目を参照で比較します。サービスがチャンクを読み込むたびに新しいオブジェクトが作成されるため、Combo は選択された項目をそれらと照合できません。
Combo をリモート データにバインドするときは、valueKey プロパティに、各項目で一意となるプロパティを設定します。
カスタム オーバーレイ設定
Combo は項目のリストをオーバーレイに表示します。オーバーレイは、OverlaySettings を overlaySettings 入力プロパティに渡して構成できます。Combo はこれらの設定を既定値にマージするため、変更したい設定のみを指定します。次の設定では、リストをモーダルにして背後のページを暗くし、ユーザーがリストの外側をクリックしたときにリストを閉じます。
import { OverlaySettings } from 'igniteui-angular/core';
// import { OverlaySettings } from '@infragistics/igniteui-angular/core'; for licensed package
export class ComboOverlayComponent {
public overlaySettings: OverlaySettings = {
modal: true,
closeOnOutsideClick: true
};
}
<igx-combo [data]="people" [overlaySettings]="overlaySettings"></igx-combo>
既定では、Combo は AutoPositionStrategy でリストを配置します。この方法では、リストは入力フィールドの下に開き、十分なスペースがない場合は上に開きます。
フィルタリング
Angular Combo は、ユーザーがドロップダウンの検索入力に入力するのに合わせて、オプションのリストをフィルタリングします。フィルタリングは既定で有効です。disableFiltering を設定するとフィルタリングが無効になり、検索入力も非表示になります。
ユーザーが検索の大文字と小文字の区別を切り替えられるようにするには、showSearchCaseIcon を設定します。これにより、Combo の検索入力に大文字と小文字を区別するアイコンが表示されます。フィルタリングが無効な間は検索入力が非表示のため、このアイコンは効果がありません。
<!-- Shows the case-sensitive icon in the search input -->
<igx-combo [showSearchCaseIcon]="true"></igx-combo>
<!-- Turns filtering off, which also hides the search input -->
<igx-combo [disableFiltering]="true"></igx-combo>
フィルタリング オプション
filteringOptions プロパティは、Angular Combo が検索テキストを照合する方法を構成します。
filteringKey- 検索対象のデータ フィールド。既定値はdisplayKeyで設定されたフィールドです。caseSensitive- 検索で大文字と小文字を区別するかどうか。既定値はfalseです。大文字と小文字を区別するアイコンがこの値を切り替えます。
次のスニペットでは、各州の名前ではなく地域を検索対象にし、大文字と小文字を区別して検索します。
import { IComboFilteringOptions } from 'igniteui-angular/combo';
// import { IComboFilteringOptions } from '@infragistics/igniteui-angular/combo'; for licensed package
export class ComboDemo {
public filteringOptions: IComboFilteringOptions = {
filteringKey: 'region',
caseSensitive: true
};
}
<igx-combo [filteringOptions]="filteringOptions"></igx-combo>
カスタム値
allowCustomValues プロパティを使用すると、データに存在しない項目をユーザーが追加できます。検索テキストに一致する項目がない場合、ドロップダウンに Add item ボタンが表示されます。このボタンは、検索テキストを新しい項目としてデータに追加します。
<igx-combo [allowCustomValues]="true"></igx-combo>
検索入力のフォーカス
Angular Combo のドロップダウンが開くと、検索入力にフォーカスが移ります。
autoFocusSearch プロパティを false に設定すると、代わりに項目のリストにフォーカスが移ります。これにより、モバイル デバイスでは、ドロップダウンと同時にソフトウェア キーボードが開くのを防げます。
<igx-combo [autoFocusSearch]="false"></igx-combo>
グループ化
groupKey にデータ項目のフィールドを設定すると、Angular Combo のオプションがそのフィールドの値ごとにヘッダーの下にグループ化されます。
<igx-combo groupKey="region"></igx-combo>
groupKey プロパティは、データ項目がオブジェクトの場合にのみ有効です。
並べ替え方向
groupSortingDirection プロパティは、Combo 内のグループの順序を設定します。SortingDirection.Asc (既定) は昇順、SortingDirection.Desc は降順に並べ替え、SortingDirection.None は各グループの先頭の項目がデータ内に現れる順にグループを並べます。各グループ内の項目は、データ内の順序のままです。
import { SortingDirection } from 'igniteui-angular/core';
// import { SortingDirection } from '@infragistics/igniteui-angular/core'; for licensed package
export class ComboDemo {
public groupSortingDirection = SortingDirection.Desc;
}
<igx-combo groupKey="region" [groupSortingDirection]="groupSortingDirection"></igx-combo>
API リファレンス
Angular Combo の完全な API リファレンスを参照してください。
その他のリソース
Combo の詳細については、次の Angular リソースを参照してください。