Single Selection Combo (単一選択コンボ)
Ignite UI for Angular Single Selection Combo は、ユーザーが 1 つのオプションを選択し、入力フィールドに入力して検索可能なドロップダウン リストをフィルタリングできる Combo です。
Angular の単一選択 Combo は Simple Combo (igx-simple-combo コンポーネント) です。Combo と同様にオプションのバインド、グループ化、テンプレート化ができ、ユーザーは入力フィールドに入力してリストをフィルタリングしたり、カスタム値を入力したりできます。
Combo には 2 つのレイアウト オプションがあります。単一選択の Combo (Simple Combo) と Combo (複数選択) です。
ライブ デモ
構造
Simple Combo は 2 つの要素で構成されます。現在の選択項目またはプレースホルダーを含む入力と、定義済みのドロップダウン リストからオプションを選択するために表示されるドロップダウンです。
2. ラベル (オプション): ユーザーが何を選択するかを説明するテキストです
3. 左アイコン (オプション): フィールドに文脈を追加する、先頭のオプション アイコンです
4. ヒント テキスト: 追加のガイダンスとしてフィールドの下に表示されるヘルパー テキストです
5. プレースホルダー テキスト: 値が選択されていないときに表示される既定のテキストです
6. トグル: オプション リストを開閉するために使用します
7. ドロップダウン ヘッダー: ドロップダウンのオプションをグループ化または説明するために使用します
8. 選択項目: ドロップダウン リストから選択された項目です
9. ドロップダウン リスト: 選択可能なオプションのリストを表示します
igx-simple-combo 要素は、入力グループ内に編集可能な入力フィールドを、オーバーレイ内にドロップダウン リストをレンダリングします。検索入力はありません。
igx-simple-combo
├─ igx-input-group
│ ├─ [igxLabel]
│ ├─ igx-prefix
│ ├─ input[igxInput][role="combobox"] // editable, filters the list
│ ├─ igx-suffix.igx-combo__clear-button // shown when the Combo has a value
│ ├─ igx-suffix // the case-sensitive icon, shown with showSearchCaseIcon
│ ├─ igx-suffix.igx-combo__toggle-button
│ └─ igx-hint
└─ igx-combo-drop-down // the dropdown, shown in an overlay
└─ div.igx-drop-down__list-scroll[role="listbox"]
└─ div.igx-combo
├─ [igxComboHeader] template
├─ div.igx-combo__content // the options
│ └─ igx-combo-item[role="option"] // role="group" for the group headers
├─ div.igx-combo__add // the empty message and the add item button
│ └─ igx-combo-add-item[role="button"] // shown with allowCustomValues
└─ [igxComboFooter] template
作業の開始
Angular Single Selection Combo を使用するには、基本的なプロジェクト セットアップについて Ignite UI for Angular の作業の開始 トピックに従い、対象のプラットフォーム向けにコンポーネントを追加します。
プロジェクトで Ignite UI for Angular をまだ使用していない場合は、ng add igniteui-angular を実行します。次に、IGX_SIMPLE_COMBO_DIRECTIVES トークンをインポートし、コンポーネントの imports に追加します。このトークンには IgxSimpleComboComponent とそのテンプレート ディレクティブが含まれています。
import { Component } from '@angular/core';
import { IGX_SIMPLE_COMBO_DIRECTIVES } from 'igniteui-angular/simple-combo';
// import { IGX_SIMPLE_COMBO_DIRECTIVES } from '@infragistics/igniteui-angular/simple-combo'; for licensed package
@Component({
selector: 'app-home',
template: `
<igx-simple-combo [data]="countries" valueKey="id" displayKey="name" placeholder="Country"></igx-simple-combo>
`,
imports: [IGX_SIMPLE_COMBO_DIRECTIVES]
})
export class HomeComponent {
public countries = [
{ id: 'BY', name: 'Belarus' },
{ id: 'BE', name: 'Belgium' },
{ id: 'BG', name: 'Bulgaria' }
];
}
使用方法
国や都市など、ユーザーが検索する必要があるリストから 1 つのオプションだけを選ぶ場合は、Angular Single Selection Combo を使用します。
タイプ (Material テーマ)
Material テーマでは、Simple Combo の入力で、単色の背景上でより構造的に見える境界線タイプと、鮮やかな画像の上に配置したときに読みやすさを高めるのに最適なボックス タイプのどちらかを選択できます。Bootstrap、Fluent、Indigo テーマでは両方のタイプが同じ見た目で描画されるため、このトピックのその他のサンプルでは、ボックス タイプを Material テーマでのみ表示しています。
Angular Simple Combo は既定でボックス タイプを使用します。境界線タイプにするには、type 入力を border に設定します。ラベルは igxLabel ディレクティブで、左アイコンは igx-prefix で追加します。IGX_SIMPLE_COMBO_DIRECTIVES トークンにはこの両方が含まれますが、アイコンは含まれないため、コンポーネントの imports に IgxIconComponent を追加します。
<!-- Border type -->
<igx-simple-combo type="border" placeholder="Select a value" [data]="options">
<label igxLabel>Label</label>
<igx-prefix><igx-icon>language</igx-icon></igx-prefix>
</igx-simple-combo>
<!-- Box type -->
<igx-simple-combo type="box" placeholder="Select a value" [data]="options">
<label igxLabel>Label</label>
</igx-simple-combo>
無効状態
Angular Single Selection Combo で disabled を設定すると、境界線タイプとボックス タイプの両方の無効状態が表示されます。
<igx-simple-combo type="border" [disabled]="true" placeholder="Country" [data]="countries"></igx-simple-combo>
サイズ
Combo には、大、中、小の 3 つのサイズがあります。ドロップダウンは、選択したサイズに合わせて自動的に寸法を調整します。サイズは --ig-size CSS 変数で設定します。
.small {
--ig-size: var(--ig-size-small);
}
.large {
--ig-size: var(--ig-size-large);
}
インタラクション状態
Combo コンポーネントは、有効なバリアントに対して 5 つの状態 (アイドル、アイドル & ホバー、入力済み、入力済み & ホバー、フォーカス) と、3 つの検証状態 (成功、警告、エラー) をサポートします。
入力フィールドまたはトグルをクリックするとドロップダウンが開き、入力フィールドに入力するとドロップダウンが開いてリストがフィルタリングされます。コードでドロップダウンを開閉するには、open、close、toggle メソッドを使用します。
@ViewChild(IgxSimpleComboComponent, { static: true })
public combo: IgxSimpleComboComponent;
public openCombo(): void {
this.combo.open();
}
次のサンプルでは、各状態を並べて表示します。ホバーとフォーカスはポインターとキーボードによって発生するため、このサンプルでは、表示専用の Combo に対して、テーマのホバー スタイルとフォーカス スタイルを有効にしています。
検証状態
経験豊富なデザイナーは、ユーザー入力を制限して無効な状態を避けるために制約を適切に使用します。そのため、検証スタイルが用意されています。利用可能な検証スタイルにより、Combo の入力は標準の Input と一貫性を保ち、成功、警告、エラーの視覚表現を表示する高度なデザインにも対応できます。
Angular Simple Combo は、バインドされているフォーム コントロール (ngModel またはリアクティブ フォーム) から検証状態を取得します。コードで状態を設定するには、valid プロパティに IgxInputState の値を設定します。Angular Simple Combo には独自の警告状態がないため、サンプルでは入力グループの警告スタイルで表示しています。ガイダンスまたはエラー メッセージは igx-hint に配置します。
<igx-simple-combo type="border" [data]="countries" valueKey="id" displayKey="name" [(ngModel)]="selection" required>
<igx-hint>Please select a different region</igx-hint>
</igx-simple-combo>
ドロップダウンのサイズ
Combo に使用されるドロップダウンは、通常の Dropdown コンポーネントと同様に、大、中、小の Combo に適したサイズで提供されます。ドロップダウンは Combo からサイズを取得するため、--ig-size 変数は Combo に設定します。
Angular Simple Combo は、項目とリストの高さを設定するための itemHeight 入力と itemsMaxHeight 入力も公開しています。
<igx-simple-combo [data]="countries" [itemHeight]="40" [itemsMaxHeight]="160"></igx-simple-combo>
次のサンプルでは、入力フィールドを除いたドロップダウンのみを表示します。
ドロップダウン項目
Simple Combo に使用されるドロップダウンは、ヘッダーと単一選択項目の 2 種類の項目をサポートします。どちらも大、中、小のサイズで利用できます。ヘッダーを使用すると、項目をグループに整理できます。
groupKey に各オプションのグループを保持するフィールドを設定すると、Angular Single Selection Combo はグループごとにヘッダーを表示します。単一選択モードのオプションにはチェックボックスが表示されません。項目とヘッダーの内容を変更するには、Combo テンプレートトピックを参照してください。
<igx-simple-combo [data]="countries" valueKey="id" displayKey="name" groupKey="region"></igx-simple-combo>
次のサンプルでは、各サイズのヘッダーと項目を表示します。
ドロップダウン項目の状態
Angular Single Selection Combo のドロップダウンの項目は、アイドル、ホバー、フォーカスのいずれかの状態になり、各状態には選択済みのバリアントがあります。ドロップダウン テーマには、無効な項目用の色も含まれています。
次のサンプルでは、各状態を並べて表示します。ホバーとフォーカスはポインターとキーボードによって発生するため、このサンプルでは、表示専用の項目に、テーマのホバー、フォーカス、無効の各状態のスタイルを適用しています。
データ バインディング
Angular Single Selection Combo は、Combo と同じ方法でオプションをバインドします。data を配列にバインドし、配列がオブジェクトを保持する場合は valueKey、displayKey、groupKey を設定します。Combo トピックのデータ バインディングを参照してください。
Angular Simple Combo は、リモート サービスにもバインドでき、データをオンデマンドで読み込みます。data を読み込まれたチャンクにバインドし、Combo の機能トピックのリモート バインディングで説明されているように、dataPreLoad イベントを処理して次のチャンクを読み込みます。
値と選択
Angular Single Selection Combo は 1 つの選択項目を保持し、その値と選択 API を通じて公開します。
Angular Simple Combo は [(ngModel)] による双方向バインディングをサポートし、テンプレート駆動フォームとリアクティブ フォームで動作します。バインドされる値は 1 つの項目で、その valueKey の値、または valueKey がない場合はオブジェクト参照です。selection プロパティは選択項目を返し、select メソッドは項目を選択し、deselect メソッドは選択をクリアします。
<igx-simple-combo [data]="countries" valueKey="id" displayKey="name" [(ngModel)]="selectedCountry"></igx-simple-combo>
export class CountriesComponent {
@ViewChild(IgxSimpleComboComponent, { static: true })
public combo: IgxSimpleComboComponent;
public selectedCountry = 'BG';
public selectBelgium(): void {
this.combo.select('BE');
}
public clear(): void {
this.combo.deselect();
}
}
Angular Simple Combo は、選択が変更される前に selectionChanging を、変更された後に selectionChanged を発行します。イベント引数には、古い値と新しい値、古い項目と新しい項目、および入力フィールドの表示テキストが含まれており、selectionChanging で cancel を設定すると選択は維持されます。
<igx-simple-combo [data]="countries" valueKey="id" displayKey="name" (selectionChanging)="onCountryChanging($event)"></igx-simple-combo>
public onCountryChanging(event: ISimpleComboSelectionChangingEventArgs): void {
if (event.newValue === 'BY') {
event.cancel = true;
}
}
selectionChanging イベントは、カスケード シナリオでも使用されます。カスケード シナリオでは、ある Simple Combo の選択によって次の Simple Combo のデータが読み込まれます (国、地域、都市の Combo など)。各 Simple Combo の selectionChanging イベントを処理して、次の Simple Combo のデータを読み込み、その選択をクリアします。
<igx-simple-combo #country
[data]="countriesData"
(selectionChanging)="countryChanging($event)"
placeholder="Choose Country..."
[(ngModel)]="selectedCountry"
displayKey="name">
</igx-simple-combo>
<igx-simple-combo #region
[data]="regionData"
(selectionChanging)="regionChanging($event)"
placeholder="Choose Region..."
[(ngModel)]="selectedRegion"
displayKey="name"
[disabled]="regionData.length === 0">
</igx-simple-combo>
<igx-simple-combo #city
[data]="citiesData"
placeholder="Choose City..."
[(ngModel)]="selectedCity"
displayKey="name"
[disabled]="citiesData.length === 0">
</igx-simple-combo>
export class SimpleComboCascadingComponent implements OnInit {
public selectedCountry: Country;
public selectedRegion: Region;
public selectedCity: City;
public countriesData: Country[];
public regionData: Region[] = [];
public citiesData: City[] = [];
public ngOnInit(): void {
this.countriesData = getCountries(['United States', 'Japan', 'United Kingdom']);
}
public countryChanging(e: ISimpleComboSelectionChangingEventArgs) {
this.selectedCountry = e.newSelection as Country;
this.regionData = getCitiesByCountry([this.selectedCountry?.name])
.map(c => ({ name: c.region, country: c.country }))
.filter((v, i, a) => a.findIndex(r => r.name === v.name) === i);
this.selectedRegion = null;
this.selectedCity = null;
this.citiesData = [];
}
public regionChanging(e: ISimpleComboSelectionChangingEventArgs) {
this.selectedRegion = e.newSelection as Region;
this.citiesData = getCitiesByCountry([this.selectedCountry?.name])
.filter(c => c.region === this.selectedRegion?.name);
this.selectedCity = null;
}
}
カスケード Combo を使用したグリッドトピックでは、Data Grid のセル編集で同じシナリオを示します。
フィルタリング
Angular Single Selection Combo の入力フィールドに入力すると、ドロップダウンが開き、入力したテキストを含むオプションにリストがフィルタリングされます。最初の一致がアクティブなオプションになるため、Enter キーで選択できます。
ユーザーの入力中にリスト全体を維持するには disableFiltering を設定し、大文字と小文字を区別するフィルタリングを切り替えるボタンを入力フィールドに表示するには showSearchCaseIcon を設定します。filteringOptions 入力は、フィルタリングに使用するキーと、フィルタリングで大文字と小文字を区別するかどうかを設定し、filterFunction はフィルタリングを独自の処理に置き換えます。選択されたオプションがない状態で Simple Combo がフォーカスを失うと、入力フィールドはクリアされます。
<igx-simple-combo [data]="countries" displayKey="name" [showSearchCaseIcon]="true"
[filteringOptions]="{ filteringKey: 'name', caseSensitive: false }">
</igx-simple-combo>
リストにない値をユーザーが入力できるようにするには、allowCustomValues を設定します。テキストがどのオプションにも一致しない場合、ドロップダウンに項目追加ボタンが表示され、そのボタンで Enter キーを押すと、テキストが新しい項目として追加されて選択されます。Simple Combo は、項目を追加する前に addition を発行します。
<igx-simple-combo [data]="countries" displayKey="name" valueKey="id" [allowCustomValues]="true" (addition)="onAddition($event)"></igx-simple-combo>
推奨 / 非推奨
Simple Combo を使用する場合、その入力とドロップダウンは同じ幅にし、左右の境界線を揃える必要があります。Simple Combo にフォーカスが当たったときのドロップダウンは、表示をトリガーした Simple Combo の後に続くコンテンツの上に常に重ねて表示する必要があります。Combo は、展開パネルのようにコンテンツを押し下げることはありません。
入力とドロップダウンを揃え、同じ幅と一致する左右の境界線にします。
入力よりも狭いドロップダウンや、位置がずれたドロップダウンは、両者の視覚的なつながりを損なうため避けてください。
プロパティ
Angular Single Selection Combo は次のプロパティを公開します。完全な型定義については API リファレンスを参照してください。
| 名前 | 型 | 既定値 | 説明 |
|---|---|---|---|
data |
any[] |
— | Simple Combo のオプション。 |
valueKey |
string |
— | オプションを識別するフィールド。 |
displayKey |
string |
— | リストと入力フィールドに表示するフィールド。valueKey にフォールバックします。 |
groupKey |
string |
— | オプションをグループ化するフィールド。 |
type |
IgxInputGroupType |
'box' |
入力フィールドのタイプ。box、border、または line。 |
placeholder |
string |
— | 項目が選択されていないときに入力フィールドに表示されるテキスト。 |
disabled |
boolean |
false |
Simple Combo が無効かどうか。 |
disableFiltering |
boolean |
false |
入力フィールドへの入力時にリストをフィルタリングしないかどうか。 |
showSearchCaseIcon |
boolean |
false |
大文字と小文字を区別するフィルタリングを切り替えるボタンを入力フィールドに表示するかどうか。 |
filteringOptions |
IComboFilteringOptions |
— | フィルタリングに使用するキー、およびフィルタリングで大文字と小文字を区別するかどうか。 |
allowCustomValues |
boolean |
false |
ユーザーが入力フィールドのテキストを新しい項目として追加できるかどうか。 |
disableClear |
boolean |
false |
クリア ボタンを非表示にするかどうか。 |
itemHeight |
number |
— | リスト内の項目の高さ。 |
itemsMaxHeight |
number |
— | リストの最大高さ。 |
valid |
IgxInputState |
INITIAL |
Simple Combo の検証状態。 |
selection |
any |
— | 読み取り専用。選択項目。 |
value |
any |
— | 読み取り専用。選択項目の valueKey の値。valueKey がない場合は項目。 |
メソッド
Angular Single Selection Combo は次のメソッドを公開します。
| メソッド | 説明 |
|---|---|
select |
渡された項目を選択し、前の項目の選択を解除します。 |
deselect |
選択をクリアします。 |
open |
ドロップダウンを開きます。 |
close |
ドロップダウンを閉じます。 |
toggle |
ドロップダウンが閉じているときは開き、開いているときは閉じます。 |
イベント
Angular Single Selection Combo は次のイベントを発行します。
| 名前 | 説明 |
|---|---|
selectionChanging |
選択が変更される前に ISimpleComboSelectionChangingEventArgs とともに発行されます。選択を維持するには cancel を設定します。 |
selectionChanged |
選択が確定した後に ISimpleComboSelectionChangedEventArgs とともに発行されます。 |
opening |
ドロップダウンが開く前に発行されます。キャンセル可能です。 |
opened |
ドロップダウンが開いた後に発行されます。 |
closing |
ドロップダウンが閉じる前に発行されます。キャンセル可能です。 |
closed |
ドロップダウンが閉じた後に発行されます。 |
searchInputUpdate |
入力フィールドのテキストが変更されたときに発行されます。 |
addition |
ユーザーがリストにカスタム値を追加する前に発行されます。 |
dataPreLoad |
リモート バインディングで、リストがまだ読み込まれていないオプションまでスクロールされたときに発行されます。 |
スタイル設定
Simple Combo は、入力とドロップダウンの両方の要素を組み合わせた柔軟なスタイル設定を提供します。入力テキスト要素の色、境界線のスタイルと色のオプションがあります。ドロップダウンについては、背景色を変更したり、Simple Combo ドロップダウン内の項目に関するさまざまなオプションで背景色とテキスト色を変更したりできます。
Angular Single Selection Combo のトグル ボタンとクリア ボタンの色は、次の CSS 変数で変更できます。
| 変数 | 変更内容 |
|---|---|
--ig-combo-toggle-button-background |
トグル ボタンの背景。 |
--ig-combo-toggle-button-foreground |
トグル ボタンのアイコンの色。 |
--ig-combo-toggle-button-foreground-filled |
Combo に値があるときのトグル ボタンのアイコンの色。 |
--ig-combo-toggle-button-background-focus |
Combo がフォーカスされているときのトグル ボタンの背景。 |
--ig-combo-toggle-button-foreground-focus |
Combo がフォーカスされているときのトグル ボタンのアイコンの色。 |
--ig-combo-toggle-button-background-disabled |
Combo が無効なときのトグル ボタンの背景。 |
--ig-combo-toggle-button-foreground-disabled |
Combo が無効なときのトグル ボタンのアイコンの色。 |
--ig-combo-clear-button-background |
クリア ボタンの背景。 |
--ig-combo-clear-button-foreground |
クリア ボタンのアイコンの色。 |
--ig-combo-empty-list-placeholder-color |
空のリストが表示するテキストの色。 |
入力フィールドは --ig-input-group-* 変数から、ドロップダウンは --ig-drop-down-* 変数から色を取得するため、これらすべてを Combo に設定できます。単一選択モードではチェックボックスが表示されないため、--ig-checkbox-* 変数は効果がありません。
Sass テーマ
プライマリ プロパティを変更すると、関連するすべての依存プロパティが自動的に更新され、変更が反映されます。combo-theme 関数のプライマリ パラメーターは $toggle-button-background で、テーマはこれからすべての状態のトグル ボタンの色を導出します。Combo とそのドロップダウンのテーマを作成し、tokens() ミックスインでインクルードします。このミックスインは、インクルードしたスコープに対応する CSS 変数を出力します。
@use "igniteui-angular/theming" as *;
$custom-combo-theme: combo-theme(
$toggle-button-background: #e0e0e0
);
$custom-drop-down-theme: drop-down-theme(
$background-color: #e6f2ff,
$selected-item-background: #4ca7e3
);
:host {
@include tokens($custom-combo-theme);
@include tokens($custom-drop-down-theme);
}
Angular Simple Combo は、オーバーレイにドロップダウンを表示します。ビューのカプセル化とオーバーレイ アウトレットの場所によっては、:host の下にインクルードしたテーマがドロップダウンに適用されない場合があります。オーバーレイのスタイル設定トピックを参照してください。
CSS 変数
Sass のビルド ステップなしでローカルにスタイルを設定する場合は、Combo またはコンテナーに CSS 変数を設定します。
.styled-combo {
--ig-input-group-border-color: #1377d5;
--ig-combo-toggle-button-background: #e0e0e0;
--ig-drop-down-background-color: #e6f2ff;
--ig-drop-down-selected-item-background: #4ca7e3;
}
Tailwind によるスタイル設定
カスタム Tailwind ユーティリティ クラスを使用して、Angular Single Selection Combo のスタイルを設定できます。最初に Tailwind をセットアップしてください。
グローバル スタイルシートで Ignite UI ユーティリティをインポートします。
@import "tailwindcss";
@import "igniteui-theming/tailwind/utilities/material.css";
対応するテーマには light-combo または dark-combo クラスを使用し、生成された CSS 変数を任意のプロパティでオーバーライドします。
<igx-simple-combo class="!light-combo ![--toggle-button-background:#e5ebf3] ![--clear-button-foreground:#212121]">
...
</igx-simple-combo>
感嘆符 (!) は、Simple Combo の既定のテーマ スタイルよりも Tailwind ユーティリティを優先させます。
アクセシビリティ
Angular Single Selection Combo は、WAI-ARIA コンボボックス パターンのロールを使用します。編集可能な入力フィールドはオプションの listbox を制御する combobox であり、ユーザーは入力でリストをフィルタリングし、キーボードでオプションを選択します。
キーボード操作
Angular Simple Combo の入力フィールドはタブ ストップであり、ユーザーが入力している間もフォーカスは入力フィールドに留まります。Simple Combo にフォーカスがある間は、次のキーが機能します。
| キー | 操作 |
|---|---|
| 印字可能な文字 | 入力フィールドで、ドロップダウンを開き、リストをフィルタリングし、最初の一致にフォーカスします。 |
| Arrow Down / Alt + Arrow Down | 閉じている Simple Combo では、ドロップダウンを開きます。開いている Simple Combo では、フォーカスをリストの選択済みオプション、または最初のオプションに移動します。リストでは、次のオプションに移動し、最後のオプションからは、項目追加ボタンが表示されている場合はそのボタンに移動します。 |
| Arrow Up | リストで、前のオプションに移動します。最初のオプションからは、フォーカスを入力フィールドに戻し、そのテキストを選択します。 |
| Alt + Arrow Up | リストで、ドロップダウンを閉じてフォーカスを入力フィールドに移動します。 |
| Home / End | リストで、最初または最後のオプションに移動します。 |
| Space | リストで、フォーカスされているオプションを選択または選択解除します。 |
| Enter | テキストに一致するフォーカスされたオプションがある入力フィールドでは、それを選択してドロップダウンを閉じます。リストでは、フォーカスされているオプションを選択し、ドロップダウンを閉じて、フォーカスを入力フィールドに移動します。項目追加ボタンでは、入力フィールドのテキストを新しい項目として追加して選択します。 |
| Backspace / Delete | 入力フィールドで、選択をクリアします。 |
| Escape | ドロップダウンが開いているときは、閉じます。ドロップダウンが閉じているときは、選択をクリアし、フォーカスを入力フィールドに維持します。 |
| Tab | ドロップダウンが開いているときは、テキストに一致するフォーカスされたオプションを選択し、ドロップダウンを閉じて、フォーカスを次のフォーカス可能な要素に移動します。 |
スクリーン リーダー / ARIA
Angular Simple Combo は、次のロールと属性をレンダリングします。
| 要素 | ロール | 属性 |
|---|---|---|
| 入力フィールドの入力 | combobox |
aria-haspopup="listbox"、aria-autocomplete="list"、aria-readonly="false"、aria-expanded、リストを指す aria-controls、aria-labelledby、aria-label |
| ドロップダウン | listbox |
igxLabel または ariaLabelledBy 要素を指す aria-labelledby |
| オプションのコンテナー | — | フォーカスされているオプションを指す aria-activedescendant |
| 各オプション | option |
aria-selected |
| 各グループ ヘッダー | group |
— |
| クリア ボタン | — | リソース文字列からの aria-label |
| 項目追加ボタン | button |
リソース文字列からの aria-label |
入力フィールドは、igxLabel または ariaLabelledBy 入力からアクセシブル名を取得します。これらがない場合は、オプションが選択されているかどうかを示すリソース文字列から名前を取得します。
アクセシビリティ準拠
Infragistics は、アクセシビリティ準拠トピックで、Section 508 と WCAG 2.1 のガイドライン領域に対する Ignite UI for Angular のアクセシビリティ サポートを文書化しています。
| 基準 | コンポーネントの準拠方法 |
|---|---|
| 1.3.1 情報及び関係性 | combobox、listbox、option ロールが構造を公開し、リストはigxLabel または ariaLabelledBy 要素によってラベル付けされます。 |
| 2.1.1 キーボード | 入力でリストがフィルタリングされ、矢印キーでドロップダウンを開いてオプション間を移動でき、Enter キーでアクティブなオプションを選択します。 |
| 2.1.2 キーボード トラップなし | Tab キーでドロップダウンが閉じ、フォーカスが Combo の外に移動します。 |
| 4.1.2 名前、役割、値 | 入力フィールドは、combobox ロール、ラベルからの名前、および aria-expanded による展開状態を公開します。各オプションは、aria-selected によって選択状態を公開します。 |
開発者の責任:
- すべての Combo に、ユーザーが何を選択するかを示すラベルを付けます。タイプ (Material テーマ)を参照してください。
- テーマの色をオーバーライドする場合は、1.4.11 非テキストのコントラストで要求されているとおり、境界線とフォーカス インジケーターに 3:1 以上のコントラスト比を維持します。
- エラー メッセージは、色だけでなくヘルパー テキストに表示します。検証状態を参照してください。
既知の制限
- Angular Simple Combo が
undefinedを含むプリミティブの配列にバインドされている場合、リストにはundefinedが表示されません。オブジェクトのvalueKeyフィールドがundefinedの場合、リストには項目が表示されますが、ユーザーは選択できません。 - Angular Simple Combo が
ngModelにバインドされていてrequiredの場合、null、undefined、''の値は選択できません。 - Angular Simple Combo がリモート サービスにバインドされていて、事前定義された選択がある場合、データが読み込まれるまで入力フィールドは空白のままです。
- リストは Virtual Scroll を使用するため、その制限が適用されます。リストは表示範囲内のオプションのみをレンダリングするため、DOM を照会するコードは、それらのオプションしか見つけられません。
API リファレンス
Angular Single Selection Combo の API リファレンスは、対象プラットフォームの完全な API サーフェスを一覧表示します。
依存関係
Angular Single Selection Combo は、色とサイズを適用するためにテーマを必要とします。フレームワーク固有のセットアップについては、作業の開始を参照してください。
Angular Simple Combo は、Drop Down、Input Group、Icon、Overlay を使用します。これらのテーマが各パーツのスタイルを設定します。
その他のリソース
Angular Single Selection Combo に関するその他のガイダンスとプロジェクト サポートについては、次のリソースを参照してください。
関連コンポーネント
Angular Single Selection Combo は、ユーザーがリストを検索して 1 つのオプションを選択できるようにします。選択の動作が異なる場合は、次のコンポーネントを使用します。
- Combo - ユーザーが複数のオプションを選択する場合に Combo を使用します。
- Select - 検索が不要な短いリストから、ユーザーが 1 つのオプションを選ぶ場合に Select を使用します。
- Dropdown - ボタンやその他の要素からアクションまたはオプションのリストを表示する場合に Dropdown を使用します。
FAQ
これらの質問では、Angular Single Selection Combo の一般的なセットアップ、選択、使用シナリオを取り上げます。
Combo の代わりに、Angular Simple Combo (igx-simple-combo コンポーネント) を使用します。Simple Combo は 1 つの項目を選択し、ユーザーは入力フィールドに入力してリストをフィルタリングできます。
Angular Simple Combo を [(ngModel)] またはフォーム コントロールで 1 つの valueKey の値にバインドするか、項目を指定して select メソッドを呼び出します。valueKey がない場合、Simple Combo は data 内のオブジェクトへの参照を使用します。
はい。Angular Simple Combo で allowCustomValues を設定すると、テキストがどのオプションにも一致しない場合にドロップダウンに項目追加ボタンが表示されます。Simple Combo は、そのテキストを新しい項目として追加して選択します。
Angular Simple Combo は displayKey フィールドでフィルタリングします。disableFiltering が設定されていないこと、および filteringOptions または filterFunction がリストに表示するフィールドと一致していることを確認してください。
リストが長く、ユーザーが入力して検索する必要がある場合は、Angular Single Selection Combo を使用します。検索せずにオプションを選ぶ短いリストには、Angular Select を使用します。