From 34625e7dea9343bc7be318acf71c080932c92c01 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 16 Nov 2026 15:38:06 +0000 Subject: [PATCH] docs(jp): sync combo topics Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../jp/components/inputs/combo/overview.mdx | 1407 +++++++++++++--- .../inputs/combo/single-selection.mdx | 1438 ++++++++++++++++- .../jp/components/inputs/combo/templates.mdx | 658 ++++++-- .../accessibility-compliance.mdx | 6 +- 4 files changed, 3062 insertions(+), 447 deletions(-) diff --git a/docs/xplat/src/content/jp/components/inputs/combo/overview.mdx b/docs/xplat/src/content/jp/components/inputs/combo/overview.mdx index 8c236ceba9..4e6856a94c 100644 --- a/docs/xplat/src/content/jp/components/inputs/combo/overview.mdx +++ b/docs/xplat/src/content/jp/components/inputs/combo/overview.mdx @@ -1,66 +1,190 @@ --- -title: "{Platform} コンボボックス コンポーネント – {ProductName}" -description: "{Platform} Combo コンポーネントは、基本的な HTML 入力、選択、フィルタリング、およびカスタム ドロップダウン リストの機能を組み合わせた強力な入力を提供します。無料でお試しください。" -keywords: "{ProductName}, UI コントロール, {Platform} ウィジェット, web ウィジェット, UI ウィジェット, {Platform}, ネイティブ {Platform} コンポーネント スイート, ネイティブ {Platform} コントロール, ネイティブ {Platform} コンポーネント ライブラリ, {Platform} コンボボックス コンポーネント" +title: "{Platform} Combo (コンボ) コンポーネント" +description: "{ProductName} Combo (コンボ) は、入力フィールドと検索可能なドロップダウン リストを組み合わせたコンポーネントです。入力してオプションをフィルタリングし、1 つ以上の項目を選択できます。" +keywords: "{Platform} Combo, {ProductName}, コンボ, コンボボックス, 複数選択ドロップダウン, 検索可能なドロップダウン, コンボのフィルタリング, コンボのグループ化" license: MIT +last_updated: "2026-11-03" +relatedComponents: ["Select", "Dropdown"] mentionedTypes: ["Combo", "ComboItem", "ComboHeader", "ComboList"] _language: ja llms: - description: "{Platform} コンボボックスは、ユーザーが提供されたリストでさまざまな定義済みオプションを簡単に選択、フィルタリング、およびグループ化できるようにする軽量のエディターです。" + description: "{ProductName} Combo (コンボ) は、入力フィールドと検索可能なドロップダウン リストを組み合わせたコンポーネントで、ユーザーは入力してオプションをフィルタリングし、1 つ以上の項目を選択できます。" --- -import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'; import PlatformBlock from 'igniteui-astro-components/components/mdx/PlatformBlock.astro'; import Sample from 'igniteui-astro-components/components/mdx/Sample.astro'; import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro'; +import Anatomy from 'igniteui-astro-components/components/mdx/Anatomy.astro'; +import DoDont from 'igniteui-astro-components/components/mdx/DoDont.astro'; +import Faq from 'igniteui-astro-components/components/mdx/Faq.astro'; +import FaqItem from 'igniteui-astro-components/components/mdx/FaqItem.astro'; +import comboAnatomy from '@xplat-images/anatomy-content-light/combo-input-lt-a.png'; +import comboDoAlignment from '@xplat-images/combo/combo-do-1.png'; +import comboDoNotAlignment from '@xplat-images/combo/combo-do-not-1.png'; +# {Platform} Combo (コンボ) +{ProductName} Combo (コンボ) は、入力フィールドと検索可能なドロップダウン リストを組み合わせたコンポーネントで、ユーザーは入力してオプションをフィルタリングし、1 つ以上の項目を選択できます。 -# {Platform} コンボボックスの概要 + -{Platform} コンボボックスは、ユーザーが提供されたリストでさまざまな定義済みオプションを簡単に選択、フィルタリング、およびグループ化できるようにする軽量のエディターです。このコンポーネントは、{Platform} コンボボックス キーボード ナビゲーションのオプション、項目、ヘッダー、およびフッターの表示方法をカスタマイズするためのテンプレートもサポートしています。 +Angular Combo は `igx-combo` コンポーネントです。仮想化されたドロップダウン リストにオプションを表示し、フィルタリング、グループ化、カスタム値、および Angular フォームとの双方向バインディングをサポートします。 -{ProductName} コンボボックス コンポーネントは、ユーザーが選択できるオプションのリストを提供します。仮想化された項目のリストにすべてのオプションが表示されます。つまり、コンボボックスは、1 つ以上のオプションを選択できる数千のレコードを同時に表示できます。さらに、このコンポーネントには、大文字と小文字を区別するフィルタリング、グループ化、複雑なデータ バインディングなどの機能があります。 + -## {Platform} コンボボックスの例 + - +Combo は仮想化されたリストにオプションを表示するため、リストに数千のオプションを含めることができます。Combo は、大文字と小文字を区別するフィルタリング、グループ化、および複雑なデータへのバインディングをサポートします。 + +## デモ -## {Platform} コンボボックス コンポーネントを使用した作業の開始 + + - + + + + + + + + +## 構造 + +Combo は、入力フィールドと検索可能なドロップダウン リストを組み合わせたもので、ユーザーは入力してオプションをフィルタリングし、1 つ以上の項目を選択できます。 + + + + + +1. 入力コンテナー: 値と入力要素を表示します
+2. ラベル (オプション): ユーザーが選択する内容を説明するテキストです
+3. 左アイコン (オプション): フィールドに文脈を加える、先頭のアイコンです
+4. ヒント テキスト: 追加のガイダンスとして、フィールドの下に表示されるヘルパー テキストです
+5. プレースホルダー テキスト: 値が選択されていない場合に表示される既定のテキストです
+6. トグル: オプション リストを開いたり閉じたりするために使用します
+7. 検索入力: 入力してリストをフィルタリングできます
+8. ドロップダウン ヘッダー: ドロップダウンのオプションをグループ化または説明するために使用します
+9. 選択された項目: ドロップダウン リストから選択された項目です
+10. ドロップダウン リスト: 選択可能なオプションのリストを表示します
+ + + +`igc-combo` 要素は、入力フィールドとドロップダウン リストをポップオーバー内に、その下にヘルパー テキストをレンダリングします: + +```text +igc-combo +└─ #shadow-root + ├─ igc-popover + │ ├─ igc-input#target[slot="anchor"] // the input field, exported as the "input" part + │ │ ├─ slot[name="prefix"] + │ │ ├─ span[part="clear-icon"] // shown when the Combo has a value + │ │ ├─ slot[name="suffix"] + │ │ └─ span[part="toggle-icon"] + │ └─ div[part="list-wrapper"] // the dropdown + │ ├─ div[part="filter-input"] + │ │ └─ igc-input[part="search-input"] // hidden with disable-filtering or single-select + │ ├─ div[part="header"] + │ │ └─ slot[name="header"] + │ ├─ igc-virtual-scroll#dropdown[part="list"][role="listbox"] + │ │ ├─ igc-combo-header[part="group-header"] // one for each group + │ │ └─ igc-combo-item[part="item"] // one for each option + │ ├─ div[part="empty"] // shown when the list has no options + │ │ └─ slot[name="empty"] + │ └─ div[part="footer"] + │ └─ slot[name="footer"] + └─ igc-validator[part="helper-text"] // the helper text and the validation messages +``` + + + + + +`igx-combo` 要素は、入力フィールドを入力グループ内に、ドロップダウン リストをオーバーレイ内にレンダリングします: + +```text +igx-combo +├─ igx-input-group +│ ├─ [igxLabel] +│ ├─ igx-prefix +│ ├─ input[igxInput][role="combobox"] // read-only, shows the selected items +│ ├─ igx-suffix.igx-combo__clear-button // shown when the Combo has a value +│ ├─ 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 + ├─ div.igx-combo__search // hidden with disableFiltering + │ └─ input[igxInput][role="searchbox"] + ├─ [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 +``` + + +## 作業の開始 -まず、次のコマンドを実行して {ProductName} をインストールする必要があります: +{Platform} Combo を使用するには、基本的なプロジェクトのセットアップについて [{ProductName} 作業の開始](../../general/getting-started.mdx)[{ProductName} 作業の開始](../../general-getting-started.mdx)トピックに従い、対象のプラットフォームにコンポーネントを追加します。 + + + +**{PackageCommon}** パッケージをインストールします: ```cmd -npm install {PackageWebComponents} +npm install {PackageCommon} ``` - コンポーネントを使用する前に、追加のコンポーネントおよび必要な CSS とともに登録する必要があります: +次に、、そのテーマ CSS をインポートし、コンポーネントを登録します。この登録により、Combo がレンダリングする入力、アイコン、ポップオーバーの各要素も登録されます: ```ts -import { defineComponents, IgcComboComponent } -from 'igniteui-webcomponents'; +import { defineComponents, IgcComboComponent } from 'igniteui-webcomponents'; import 'igniteui-webcomponents/themes/light/bootstrap.css'; defineComponents(IgcComboComponent); ``` -{ProductName} の完全な概要については、[作業の開始](../../general-getting-started.mdx)トピックを参照してください。 + + - +**{PackageCommon}** パッケージをインストールします: +```cmd +npm install {PackageCommon} +``` +次に、 ラッパーとテーマ CSS をインポートします: - +```tsx +import { IgrCombo } from 'igniteui-react'; +import 'igniteui-webcomponents/themes/light/bootstrap.css'; +``` + + -{ProductName} のサービスを登録します。 +{ProductName} のサービスを登録します: ```csharp // in Program.cs file @@ -68,9 +192,9 @@ defineComponents(IgcComboComponent); builder.Services.AddIgniteUIBlazor(); ``` - のクライアント リソース モジュールである の登録は**任意**です。コンポーネントは初めてレンダリングされるときにリソースを読み込みます。ただし、`builder.Services.AddIgniteUIBlazor(typeof(IgbComboModule))` のように指定すると、リソースを事前に読み込んだり、クライアント側でのみ作成される要素に対応したりできます ([コンポーネント モジュール](../../general-getting-started.mdx#コンポーネント-モジュール)を参照)。 + のクライアント リソース モジュールである の登録は**任意**です。コンポーネントは初めてレンダリングされるときにリソースを読み込みます。`builder.Services.AddIgniteUIBlazor(typeof(IgbComboModule))` のように指定すると、リソースを事前に読み込んだり、クライアント側でのみ作成される要素に対応したりできます ([コンポーネント モジュール](../../general-getting-started.mdx#component-modules)を参照)。 -スタイルを コンポーネントに適用するには、追加の CSS ファイルをリンクする必要もあります。以下は、アプリのホスト ページ (スタンドアロンの Blazor WebAssembly アプリまたは Blazor Hybrid アプリでは **wwwroot/index.html**、Blazor Server アプリでは **Pages/_Host.cshtml**、Blazor Web App では **Components/App.razor**) に配置する必要があります。 +次に、アプリのホスト ページ (スタンドアロンの Blazor WebAssembly アプリまたは Blazor Hybrid アプリでは **wwwroot/index.html**、Blazor Server アプリでは **Pages/_Host.cshtml**、Blazor Web App では **Components/App.razor**) でテーマ CSS ファイルをリンクします: ```razor @@ -78,65 +202,122 @@ builder.Services.AddIgniteUIBlazor(); + +プロジェクトで {ProductName} をまだ使用していない場合は、`ng add igniteui-angular` を実行します。次に、`IGX_COMBO_DIRECTIVES` トークンをインポートし、コンポーネントの `imports` に追加します。このトークンには、 とそのテンプレート ディレクティブが含まれています: - +```ts +import { Component } from '@angular/core'; +import { IGX_COMBO_DIRECTIVES } from 'igniteui-angular/combo'; +// import { IGX_COMBO_DIRECTIVES } from '@infragistics/igniteui-angular/combo'; for licensed package + +@Component({ + selector: 'app-home', + template: ` + + `, + imports: [IGX_COMBO_DIRECTIVES] +}) +export class HomeComponent { + public cities = [ + { id: 'BG01', name: 'Sofia' }, + { id: 'BG02', name: 'Plovdiv' }, + { id: 'BG03', name: 'Varna' } + ]; +} +``` + + -まず、次のコマンドを実行して、対応する {ProductName} npm パッケージをインストールする必要があります: +登録後、Combo をレンダリングし、その `data` をオプションの配列にバインドします。`valueKey` はオプションを識別するフィールドを指定し、`displayKey` はリストに表示するフィールドを指定します: -```cmd -npm install igniteui-react -``` + -次に、以下のように、{Platform} と必要な CSS をインポートする必要があります: + -```tsx -import { IgrCombo } from 'igniteui-react'; -import 'igniteui-webcomponents/themes/light/bootstrap.css'; +```html + ``` +```ts +const combo = document.getElementById('cities') as IgcComboComponent; - +combo.data = [ + { id: 'BG01', name: 'Sofia' }, + { id: 'BG02', name: 'Plovdiv' }, + { id: 'BG03', name: 'Varna' } +]; +``` + - - コンポーネントは標準の `
` 要素では機能しません。代わりに `Form` を使用してください。 - + -次に、オプションのリストを構築するコンボ データ ソースに、オブジェクトの配列をバインドします。 +```tsx +const cities = [ + { id: 'BG01', name: 'Sofia' }, + { id: 'BG02', name: 'Plovdiv' }, + { id: 'BG03', name: 'Varna' } +]; - + +``` -```ts -interface City { - id: string; - name: string; -} + -const cities: City[] = [ - { name: 'London', id: 'UK01' }, - { name: 'Sofia', id: 'BG01'}, - { name: 'New York', id: 'NY01'} -]; + -export class Sample { - private combo: IgcComboComponent; +```razor + - constructor() { - this.combo = document.getElementById('basic-combo') as IgcComboComponent; - this.combo.data = cities; +@code { + private class City + { + public string Id { get; set; } + public string Name { get; set; } } + + private List Cities = new() + { + new City { Id = "BG01", Name = "Sofia" }, + new City { Id = "BG02", Name = "Plovdiv" }, + new City { Id = "BG03", Name = "Varna" } + }; } ``` +## 使用方法 + +長いリストから 1 つ以上のオプションを選択し、検索する必要がある場合 (都市や国のリストなど) に、{Platform} Combo を使用します。 + +### タイプ + +Combo の入力には、単色の背景上でより構造的に見せるための枠線タイプと、鮮やかな画像の上に配置したときに読みやすさを向上させるのに最適なボックス タイプがあります。 + + + +{Platform} Combo は既定でボックス タイプを使用します。枠線タイプにするには `outlined` を設定します。ボックス タイプは Material テーマのスタイルであり、Bootstrap、Fluent、Indigo テーマでは、どちらのタイプも同じ外観になります。 + + + ```html - + + +``` + + + + + +```tsx + + ``` @@ -144,33 +325,55 @@ export class Sample { ```razor - + + +``` -@code { - private class City { - public string Id { get; set; } - public string Name { get; set; } - public string Country { get; set; } - } + - private List Data = new List { - new City { - Id = "UK01", - Name = "London", - Country = "United Kingdom", - }, - new City { - Id = "BG01", - Name = "Sofia", - Country = "Bulgaria", - }, - new City { - Id = "US01", - Name = "New York", - Country = "United States", - }, - }; -} + + +Angular Combo は既定でボックス タイプを使用します。枠線タイプにするには、 入力プロパティを `border` に設定します。ラベルは `igxLabel` ディレクティブで、左アイコンは `igx-prefix` で追加します: + +```html + + + language + + + + + +``` + + + + + +ラベルは `label` プロパティで、左アイコンは `prefix` スロットに追加します。[アイコン](../../layouts/icon.mdx)トピックの説明に従って、先にアイコンを登録します。 + + + + + + + + + + + + + + + +### 無効状態 + +{Platform} Combo に `disabled` を設定すると、枠線タイプとボックス タイプの両方の無効状態が表示されます。 + + + +```html + ``` @@ -178,56 +381,85 @@ export class Sample { ```tsx -interface City { - id: string; - name: string; -} + +``` -const cities: City[] = [ - { name: "London", id: "UK01" }, - { name: "Sofia", id: "BG01" }, - { name: "New York", id: "NY01" }, -]; + - + + +```razor + ``` -### データ値と表示プロパティ + -コンボは複雑なデータ (オブジェクト) の配列にバインドされている場合、コントロールが項目の選択を処理するために使用するプロパティを指定する必要があります。コンポーネントは以下のプロパティを公開します: +```html + +``` + + -- `T` - *必須。 が省略されている場合は、これを 「object」 に設定する必要があります。それ以外の場合は、 のプロパティ タイプと一致する必要があります。 -- - オプション、複雑なデータ オブジェクトに**必須** - データ ソースのどのフィールドを選択に使用するかを決定します。 が省略された場合、選択 API はオブジェクト参照を使用して項目を選択します。 -- - オプション、複雑なデータ オブジェクトに**推奨** - データ ソース内のどのフィールドが表示値として使用されるかを決定します。 に値が指定されていない場合、コンボは指定された (存在する場合) を使用します。 -この例では、コンボで各都市の `name` を表示し、項目の選択と各項目の基礎となる値として `id` フィールドを使用するようにします。したがって、これらのプロパティをコンボの と にそれぞれ提供します。 + - -データ ソースがプリミティブ型 (例: `strings`、`numbers` など) で構成されている場合、 や を**指定しないでください**。 - + -### 値の設定 + + + -ComboBox コンポーネントは、属性 (値とも呼ばれます) に加えて、 ゲッターとセッターを公開します。value 属性を使用して、コンポーネントの初期化時に選択した項目を設定できます。 + + + -値 (現在選択されている項目のリスト) を読み取る場合、または値を更新する場合は、それぞれ値ゲッターとセッターを使用します。値ゲッターは、 で表される選択されたすべての項目のリストを返します。同様に、値セッターを使用して選択した項目のリストを更新する場合は、 によって項目のリストを提供する必要があります。 +### サイズ + +Combo には、大、中、小の 3 つのサイズがあります。ドロップダウンは、選択したサイズに合わせて寸法が自動的に調整されます。サイズは `--ig-size` CSS 変数で設定します: + +```css +.small { + --ig-size: var(--ig-size-small); +} + +.large { + --ig-size: var(--ig-size-large); +} +``` + + + +{Platform} Combo は既定で中サイズです。 + + + + + + + + + + + + + + + +### インタラクション状態 + +Combo コンポーネントは、有効なバリエーションに対して、アイドル、アイドルとホバー、入力済み、入力済みとホバー、フォーカスの 5 つの状態と、成功、警告、エラーの 3 つの検証状態をサポートします。 + +入力フィールドまたはトグルをクリックすると、ドロップダウンが開きます。コードでドロップダウンを開閉するには、`open` プロパティ、または `show`、`hide`、`toggle` メソッド`Open` パラメーター、または `ShowAsync`、`HideAsync`、`ToggleAsync` メソッド`open`、`close`、`toggle` メソッドを使用します: ```ts -const combo = document.getElementById('basic-combo') as IgcComboComponent; +const combo = document.querySelector('igc-combo'); -// Given the overview example from above this will return ['BG01'] -console.log(combo.value); - -// Change the selected items to New York and London -combo.value = ['NY01', 'UK01']; +await combo.show(); +await combo.hide(); +await combo.toggle(); ``` @@ -237,241 +469,948 @@ combo.value = ['NY01', 'UK01']; ```tsx const comboRef = useRef(null); -// Given the overview example from above this will return ['BG01'] -console.log(comboRef.current.value); - -// Change the selected items to New York and London -comboRef.current.value = ['NY01', 'UK01']; +comboRef.current.show(); +comboRef.current.hide(); +comboRef.current.toggle(); ``` -### 選択 API + -コンボ コンポーネントは、現在選択されている項目を変更できる API を公開します。 +```razor + -ユーザーの操作によってオプションのリストから項目を選択する以外に、プログラムで項目を選択することもできます。これは、 および メソッドを介して行われます。項目の配列をこれらのメソッドに渡すことができます。メソッドが引数なしで呼び出された場合、呼び出されたメソッドに応じて、すべての項目が選択 / 選択解除されます。コンボ コンポーネントに を指定した場合は、選択 / 選択解除する項目の値キーを渡す必要があります。 +@code { + private IgbCombo Combo; -#### 一部の項目を選択 / 選択解除 + private async Task OpenAsync() => await Combo.ShowAsync(); +} +``` - + + ```ts -// Select/deselect items by their IDs as valueKey is set to 'id' -combo.select(['BG01', 'BG02', 'BG03', 'BG04']); -combo.deselect(['BG01', 'BG02', 'BG03', 'BG04']); +@ViewChild(IgxComboComponent, { static: true }) +public combo: IgxComboComponent; + +public openCombo(): void { + this.combo.open(); +} +``` + + + +次のサンプルでは、各状態を並べて表示します。ホバーとフォーカスはポインターとキーボードによるものであるため、このサンプルでは、これらの状態を表示するだけのコンボに CSS クラスでスタイルを設定しています。 + + + + + + + + + + + + + +### 検証状態 + +経験豊富なデザイナーは、ユーザー入力を制限して無効な状態を避けるために制約を適切に使用します。そのため、検証スタイルが用意されています。利用可能な検証スタイルにより、Combo の入力は標準の [入力](../../input-group.mdx)[入力](../input.mdx)と一貫性を保ち、成功、警告、エラーの視覚効果を表示する高度なデザインにも対応します。 + + + +{Platform} Combo はフォームに関連付けられています。少なくとも 1 つの項目の選択を必須にするには `required` を設定し、エラー状態を表示するには `invalid` を設定します。ガイダンスまたはエラー メッセージは `helper-text` スロットに配置します。Combo は、制約検証 API の `checkValidity`、`reportValidity`、`setCustomValidity` メソッドも公開します。Combo には組み込みの成功状態と警告状態がないため、サンプルではこれら 2 つの状態に CSS クラスでスタイルを設定しています。 + + + + + +```html + + Please select a different region + ``` + + +```tsx + + Please select a different region + +``` + + ```razor - + + Please select a different region +``` -@code { - private List Data; - private IgbCombo Combo; - private object[] Cities; + - protected override void OnInitialized() { - this.Data = SampleData.Cities; - this.Cities = new object[] { "UK01", "UK02", "UK03", "UK04", "UK05" }; - } + - public void SelectCities() { - this.Combo.Select(Cities); - } +Angular Combo は、`ngModel` またはリアクティブ フォームを介してバインドされているフォーム コントロールから検証状態を取得します。コードで状態を設定するには、 プロパティに `IgxInputState` 値を設定します。ガイダンスまたはエラー メッセージは `igx-hint` に配置します: - public void DeselectCities() { - this.Combo.Deselect(Cities); - } -} +```html + + Please select a different region + ``` + - + + -```tsx -// Select/deselect items by their IDs as valueKey is set to 'id' -comboRef.current.select(["UK01", "UK02", "UK03", "UK04", "UK05"]); -comboRef.current.deselect(["UK01", "UK02", "UK03", "UK04", "UK05"]); + + + + + + +### ドロップダウンのサイズ + +Combo に使用されるドロップダウンは、通常の [ドロップダウン](../../drop-down.mdx)[ドロップダウン](../dropdown.mdx)コンポーネントと同様に、大、中、小の Combo に適したサイズで提供されます。ドロップダウンのサイズは Combo から決まるため、Combo に `--ig-size` 変数を設定します。 + + + +Angular Combo は、項目とリストの高さを設定する および 入力プロパティも公開します: + +```html + ``` +次のサンプルでは、入力フィールドを除いて、ドロップダウンのみを表示します。 + + + + + + + + + + + + + +### ドロップダウンの検索入力 + +{Platform} Combo のドロップダウンには、ユーザーの入力に合わせてオプションをフィルタリングする検索入力が含まれています。 + + -#### すべての項目を選択 / 選択解除 +空の検索入力のテキストは `placeholderSearch` で設定し、大文字と小文字を区別するフィルタリングを切り替えるボタンは `caseSensitiveIcon` で表示し、検索入力は `disableFiltering` で非表示にします。`filteringOptions` オブジェクトは、検索でフィルタリングに使用するキー、およびフィルタリングで大文字と小文字を区別するか、発音区別記号を照合するかを設定します: + + +```html + +``` ```ts -// Select/deselect all items -combo.select(); -combo.deselect(); +combo.filteringOptions = { filterKey: 'name', caseSensitive: false, matchDiacritics: true }; ``` + + +```tsx + +``` + + ```razor -@code { - public void SelectAll() { - this.Combo.Select(new object[] {}); - } + +``` - public void DeselectAll() { - this.Combo.Deselect(new object[] {}); - } -} + + + + +空の検索入力のテキストは で設定し、大文字と小文字を区別するフィルタリングを切り替えるボタンは で表示し、検索入力は で非表示にします。 入力プロパティは、検索でフィルタリングに使用するキー、およびフィルタリングで大文字と小文字を区別するかどうかを設定します: + +```html + + ``` +次のサンプルでは、検索入力のみを表示します。状態はポインターとキーボードによるものであるため、このサンプルでは、表示専用の検索入力に CSS クラスでスタイルを設定しています。 - + + + + + + + + + + + + +### データ バインディング + +{Platform} Combo は、`data` にバインドした配列からオプションのリストを構築します。配列にオブジェクトが含まれる場合は、Combo が使用するキーを設定します: + + + +- - オプションを識別するフィールドです。Combo の値と選択 API で使用されます。省略した場合、Combo はオブジェクトへの参照を使用します。 +- - リストと入力フィールドに表示するフィールドです。省略した場合、Combo は `valueKey` を使用します。 +- - オプションをグループ化するフィールドです。各グループにヘッダーが表示され、 でグループを昇順または降順に並べ替えます。 + + + + +- - オプションを識別するフィールドです。Combo の値と選択 API で使用されます。省略した場合、Combo はオブジェクトへの参照を使用します。 +- - リストと入力フィールドに表示するフィールドです。省略した場合、Combo は `ValueKey` を使用します。 +- - オプションをグループ化するフィールドです。各グループにヘッダーが表示され、 でグループを昇順または降順に並べ替えます。 + +Blazor Combo の `T` 型パラメーターは、その値の型です。`ValueKey` フィールドの型に設定するか、`ValueKey` を設定しない場合はオプションの型に設定します。`@bind-Value` で `Value` をバインドすると、Razor はバインドされたフィールドから `T` を推論します。 + + + + + +- - オプションを識別するフィールドです。Combo の値と選択で使用されます。省略した場合、Combo はオブジェクトへの参照を使用します。 +- - リストと入力フィールドに表示するフィールドです。省略した場合、Combo は `valueKey` を使用します。 +- - オプションをグループ化するフィールドです。各グループにヘッダーが表示され、 でグループを並べ替えます。 + +リモート サービスから読み込まれるデータにバインドするには、[リモート バインディング](../../combo-remote.mdx)トピックを参照してください。 + + + +配列に文字列や数値などのプリミティブ値が含まれる場合は、`valueKey` と `displayKey` を設定しないでください。Combo は値そのものを使用します。 + +### 値と選択 + +{Platform} Combo は、選択された項目を値を通じて公開し、コードで項目を選択および選択解除するメソッドを提供します。 + + + +`value` は、選択された項目を `valueKey` の値として、または `valueKey` がない場合はオブジェクト参照として保持します。Combo の初回レンダリング時に項目を選択するには、これを設定します。`select` および `deselect` メソッドは項目の配列を受け取ります。項目なしで呼び出すと、すべての項目を選択または選択解除します: + + + + + +```ts +// select and deselect items by their ids, because the valueKey is 'id' +combo.select(['BG01', 'BG02']); +combo.deselect(['BG01']); + +// select and deselect all items +combo.select(); +combo.deselect(); + +console.log(combo.value); // the ids of the selected items +``` + + + + ```tsx -// Select/deselect all items +// select and deselect items by their ids, because the valueKey is 'id' +comboRef.current.select(['BG01', 'BG02']); +comboRef.current.deselect(['BG01']); + +// select and deselect all items comboRef.current.select([]); comboRef.current.deselect([]); + +console.log(comboRef.current.value); // the ids of the selected items ``` + - プロパティを省略した場合は、オブジェクト参照として選択 / 選択解除する項目を列挙する必要があります。 +```razor +@code { + private IgbCombo Combo; + public void SelectCities() => Combo.Select(new object[] { "BG01", "BG02" }); - + public void DeselectAll() => Combo.Deselect(new object[] { }); +} +``` + + + + + +ユーザーが単一の項目を選択し、入力フィールドに入力してリストをフィルタリングできるようにするには、[単一選択](./single-selection.mdx)モードを使用します。 + + + + + +Angular Combo は `[(ngModel)]` による双方向バインディングをサポートし、テンプレート駆動フォームとリアクティブ フォームで動作します。 プロパティは選択された項目を返し、、、、 メソッドで変更します: +```html + +``` ```ts -// Select/deselect values by object references when no valueKey is provided -combo.select([cities[1], cities[5]]); -combo.deselect([cities[1], cities[5]]); +export class CitiesComponent { + @ViewChild(IgxComboComponent, { static: true }) + public combo: IgxComboComponent; + + public selectedCities: string[] = ['BG01', 'UK01']; + + public selectFavorites(): void { + this.combo.select(['UK01', 'BG01']); + } +} ``` +Angular Combo は、選択が変更される前にキャンセル可能な を発行し、選択が確定した後に を発行します。 + +ユーザーが単一の項目を選択し、入力フィールドに入力できるようにするには、[シンプル コンボ](./single-selection.mdx)を使用します。 + +### 推奨事項と非推奨事項 +Combo を使用する場合、入力とドロップダウンは同じ幅にし、左右の境界線を揃える必要があります。Combo にフォーカスがあるときのドロップダウンの表示については、Combo による表示のトリガーに続くコンテンツの上に常に表示する必要があります。Combo は、展開パネルのようにコンテンツを押し下げることはありません。 - + + +入力とドロップダウンの幅が同じで、左右の境界線が揃うように、ドロップダウンを入力に合わせます。 -```tsx -// Select/deselect values by object references when no valueKey is provided -comboRef.current.select([cities[1], cities[5]]); -comboRef.current.deselect([cities[1], cities[5]]); -``` + + + +ドロップダウンが入力より狭い、または位置がずれていると、両者の視覚的なつながりが損なわれるため避けてください。 + + + + + +## プロパティ + +{Platform} Combo は次のプロパティを公開します。完全な型定義については、API リファレンスを参照してください。 + + + +| 名前 | 型 | 既定値 | 説明 | +| --- | --- | --- | --- | +| | `T[]` | `[]` | Combo のオプションです。 | +| | `string` | — | オプションを識別するフィールドです。 | +| | `string` | — | リストと入力フィールドに表示するフィールドです。省略した場合は `valueKey` を使用します。 | +| | `string` | — | オプションをグループ化するフィールドです。 | +| | `'asc' \| 'desc' \| 'none'` | `'asc'` | グループの並べ替え方法です。 | +| | `ComboValue[]` | `[]` | 選択された項目です。`valueKey` の値またはオブジェクト参照で指定します。 | +| | `string` | — | Combo のラベルです。 | +| | `string` | — | 項目が選択されていない場合に入力フィールドに表示されるテキストです。 | +| | `string` | — | 空の検索入力に表示されるテキストです。 | +| | `boolean` | `false` | Combo が枠線タイプを使用するかどうかです。 | +| | `boolean` | `false` | ユーザーが単一の項目を選択し、入力フィールドからリストをフィルタリングするかどうかです。 | +| `open` | `boolean` | `false` | ドロップダウンが開いているかどうかです。 | +| `disabled` | `boolean` | `false` | Combo が無効かどうかです。 | +| `required` | `boolean` | `false` | 有効になるために、Combo で項目の選択が必須かどうかです。 | +| `invalid` | `boolean` | `false` | Combo が無効状態を表示するかどうかです。 | +| | `boolean` | `false` | 検索入力を非表示にするかどうかです。 | +| | `boolean` | `false` | 検索入力に、大文字と小文字を区別するフィルタリングを切り替えるボタンを表示するかどうかです。 | +| | `FilteringOptions` | — | 検索でフィルタリングに使用するキー、およびフィルタリングで大文字と小文字を区別するか、発音区別記号を照合するかを指定します。 | +| | `boolean` | `false` | クリア ボタンを非表示にするかどうかです。 | +| | `boolean` | `false` | ドロップダウンが開いたときに、検索入力ではなくリストにフォーカスするかどうかです。 | +| | `T[]` | — | 読み取り専用です。`data` のオブジェクトとして選択された項目です。 | + + + + + +| 名前 | 型 | 既定値 | 説明 | +| --- | --- | --- | --- | +| | `object` | — | Combo のオプションです。 | +| | `string` | — | オプションを識別するフィールドです。 | +| | `string` | — | リストと入力フィールドに表示するフィールドです。省略した場合は `ValueKey` を使用します。 | +| | `string` | — | オプションをグループ化するフィールドです。 | +| | `T[]` | — | 選択された項目です。 | +| | `string` | — | Combo のラベルです。 | +| | `string` | — | 項目が選択されていない場合に入力フィールドに表示されるテキストです。 | +| | `string` | — | 空の検索入力に表示されるテキストです。 | +| | `bool` | `false` | Combo が枠線タイプを使用するかどうかです。 | +| | `bool` | `false` | ユーザーが単一の項目を選択し、入力フィールドからリストをフィルタリングするかどうかです。 | +| | `bool` | `false` | ドロップダウンが開いているかどうかです。 | +| | `bool` | `false` | Combo が無効かどうかです。 | +| | `bool` | `false` | 有効になるために、Combo で項目の選択が必須かどうかです。 | +| | `bool` | `false` | Combo が無効状態を表示するかどうかです。 | +| | `bool` | `false` | 検索入力を非表示にするかどうかです。 | +| | `bool` | `false` | 検索入力に、大文字と小文字を区別するフィルタリングを切り替えるボタンを表示するかどうかです。 | +| | `bool` | `false` | クリア ボタンを非表示にするかどうかです。 | + + + + + +| 名前 | 型 | 既定値 | 説明 | +| --- | --- | --- | --- | +| | `any[]` | — | Combo のオプションです。 | +| | `string` | — | オプションを識別するフィールドです。 | +| | `string` | — | リストと入力フィールドに表示するフィールドです。省略した場合は `valueKey` を使用します。 | +| | `string` | — | オプションをグループ化するフィールドです。 | +| | `IgxInputGroupType` | `'box'` | 入力フィールドのタイプです (`box`、`border`、または `line`)。 | +| | `string` | — | 項目が選択されていない場合に入力フィールドに表示されるテキストです。 | +| | `string` | — | 空の検索入力に表示されるテキストです。 | +| | `boolean` | `false` | Combo が無効かどうかです。 | +| | `boolean` | `false` | 検索入力を非表示にするかどうかです。 | +| | `boolean` | `false` | 検索入力に、大文字と小文字を区別するフィルタリングを切り替えるボタンを表示するかどうかです。 | +| | `IComboFilteringOptions` | — | 検索でフィルタリングに使用するキー、およびフィルタリングで大文字と小文字を区別するかどうかを指定します。 | +| | `boolean` | `false` | ユーザーが検索入力のテキストを新しい項目として追加できるかどうかです。 | +| | `boolean` | `false` | クリア ボタンを非表示にするかどうかです。 | +| | `boolean` | `true` | ドロップダウンが開いたときに、検索入力にフォーカスするかどうかです。 | +| | `number` | — | リスト内の項目の高さです。 | +| | `number` | — | リストの最大の高さです。 | +| | `IgxInputState` | `INITIAL` | Combo の検証状態です。 | +| | `any[]` | — | 読み取り専用です。選択された項目です。 | + + + +## メソッド + +{Platform} Combo は次のメソッドを公開します。 + + + +| メソッド | 説明 | +| --- | --- | +| | 渡された項目を、`valueKey` の値または参照によって選択します。何も渡さない場合は、すべての項目を選択します。 | +| | 渡された項目を、`valueKey` の値または参照によって選択解除します。何も渡さない場合は、すべての項目を選択解除します。 | +| `show` | ドロップダウンを開きます。 | +| `hide` | ドロップダウンを閉じます。 | +| `toggle` | ドロップダウンが閉じている場合は開き、開いている場合は閉じます。 | +| `checkValidity` | Combo が検証の制約を満たしているかどうかを返します。 | +| `reportValidity` | Combo の有効性をチェックし、失敗した場合は無効状態を表示します。 | + + +| メソッド | 説明 | +| --- | --- | +| | 渡された項目を選択します。空の配列を渡した場合は、すべての項目を選択します。 | +| | 渡された項目を選択解除します。空の配列を渡した場合は、すべての項目を選択解除します。 | +| | ドロップダウンを開きます。 | +| | ドロップダウンを閉じます。 | +| | ドロップダウンが閉じている場合は開き、開いている場合は閉じます。 | - + + +| メソッド | 説明 | +| --- | --- | +| | 渡された項目を選択します。2 番目の引数に `true` を渡すと、先に現在の選択をクリアします。 | +| | 渡された項目を選択解除します。 | +| | すべての項目を選択します。`true` を渡すと、現在のフィルターを無視します。 | +| | すべての項目を選択解除します。`true` を渡すと、現在のフィルターを無視します。 | +| | ドロップダウンを開きます。 | +| | ドロップダウンを閉じます。 | +| | ドロップダウンが閉じている場合は開き、開いている場合は閉じます。 | + -### 検証 +## イベント -{ProductName} Combo コンポーネントは、、、、 など、ほとんどの プロパティをサポートしています。このコンポーネントは、その検証にバインドされた 2 つのメソッドも公開しています。 +{Platform} Combo は次のイベントを発行します。 -- - 有効性をチェックし、コンポーネントが検証の制約を満たしている場合は true を返します。 -- - ネイティブ入力 API に準拠するための reportValidity のラッパー。 + -## キーボード ナビゲーション +| 名前 | 説明 | +| --- | --- | +| `igcChange` | ユーザーが選択を変更する前に発行されます。イベントの詳細には、新しい値、変更された項目、および変更の種類が含まれます。選択を維持するには、イベントをキャンセルします。 | +| `igcOpening` | ユーザーがドロップダウンを開く前に発行されます。キャンセル可能です。 | +| `igcOpened` | ユーザーの操作でドロップダウンが開いた後に発行されます。 | +| `igcClosing` | ユーザーがドロップダウンを閉じる前に発行されます。キャンセル可能です。 | +| `igcClosed` | ユーザーの操作でドロップダウンが閉じた後に発行されます。 | -コンボ コンポーネントがフォーカスされていて、オプションのリストが**表示されていない**場合: + -- ↓ または ALT + ↓ キーを使用してオプションのリストを開きます。 + -コンボ コンポーネントがフォーカスされ、オプションのリストが表示されている場合: +| 名前 | 説明 | +| --- | --- | +| | 選択が変更される前に とともに発行されます。選択を維持するには、`cancel` を設定します。 | +| | 選択が確定した後に とともに発行されます。 | +| | ドロップダウンが開く前に発行されます。キャンセル可能です。 | +| | ドロップダウンが開いた後に発行されます。 | +| | ドロップダウンが閉じる前に発行されます。キャンセル可能です。 | +| | ドロップダウンが閉じた後に発行されます。 | +| | 検索入力のテキストが変更されたときに発行されます。 | +| | ユーザーがリストにカスタム値を追加する前に発行されます。 | -- ↓ キーを使用すると、リスト内の次の項目がアクティブになります。 -- ↑ キーを使用すると、リスト内の前の項目がアクティブになります。最初の項目がすでにアクティブな場合、入力にフォーカスします。 -- HOME または END キーを使用すると、リストの最初または最後の項目がアクティブになります。 -- SPACE キーを使用すると、アクティブな項目が選択されます。 -- ENTER キーを使用すると、アクティブな項目が選択され、オプションのリストが閉じます。 -- ESC または TAB/SHIFT + TAB キーを使用すると、オプションのリストが閉じます。 + ## スタイル設定 - コンポーネントとその項目の外観は、以下に示す公開 CSS パーツを使用して変更できます。 - -| パーツ名 | 説明 | -| -------------------- | ------------------------------------------------------------------------------- | -| `label` | カプセル化されたテキスト ラベル。 | -| `input` | メイン入力フィールド。 | -| `native-input` | メイン入力フィールドのネイティブ入力。 | -| `prefix` | プレフィックス ラッパー。 | -| `suffix` | サフィックス ラッパー。 | -| `toggle-icon` | トグル アイコン ラッパー。 | -| `clear-icon` | クリア アイコン ラッパー。 | -| `case-icon` | フィルター入力のサフィックス内のコンテンツを描画するケース アイコン ラッパー。 | -| `helper-text` | ヘルパー テキスト ラッパー。 | -| `search-input` | 検索入力フィールド。 | -| `list-wrapper` | オプション ラッパーのリスト。 | -| `list` | オプションボックスのリスト。 | -| `item` | オプションのリスト内の各項目を表します。 | -| `group-header` | オプションのリストの各ヘッダーを表します。 | -| `active` | 項目がアクティブな場合に、項目パーツ リストに追加されます。 | -| `selected` | 項目が選択されている場合に、項目パーツ リストに追加されます。 | -| `checkbox` | 各リスト項目の各チェックボックスを表します。 | -| `checkbox-indicator` | 各リスト項目のチェックボックス インジケーターを表します。 | -| `checked` | チェックボックスがチェックされている場合に、チェックボックス パーツ リストに追加されます。 | -| `header` | ヘッダー コンテンツを保持するコンテナー。 | -| `footer` | フッター コンテンツを保持するコンテナー。 | -| `empty` | 空のコンテンツを保持するコンテナー。 | - - -CSS パーツを使用すると、コンボのスタイルを完全に制御できます。 +Combo には、入力とドロップダウンの各部分を組み合わせた柔軟なスタイル設定が用意されています。入力テキスト要素の色、枠線のスタイルと色を変更できます。ドロップダウンでは、背景色を変更したり、検索入力や、背景色とテキスト色を持つ項目など、Combo ドロップダウン内の項目に関するさまざまなオプションを使用したりできます。 + +次の CSS 変数で、{Platform} Combo のトグル ボタンとクリア ボタンの色を変更します: + +| 変数 | 変更内容 | +| --- | --- | +| `--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-search-separator-border-color` | 検索入力とリストの間の線の色。 | +| `--ig-combo-empty-list-placeholder-color` | 空のリストが表示するテキストの色。 | + +入力フィールドは `--ig-input-group-*` 変数から、ドロップダウンは `--ig-drop-down-*` 変数から、項目のチェックボックスは `--ig-checkbox-*` 変数から色を取得するため、これらすべてを Combo に設定できます。 + + + +`igc-combo` 要素は、次の CSS パーツを公開します: + +| パーツ | スタイルを設定する対象 | +| --- | --- | +| `input` | 入力フィールド。 | +| `native-input` | 入力フィールドのネイティブ入力。 | +| `label` | ラベル。 | +| `prefix` | `prefix` スロットのコンテナー。 | +| `suffix` | `suffix` スロットのコンテナー。 | +| `toggle-icon` | トグル ボタン。Combo に値がある場合は `filled` が追加されます。 | +| `clear-icon` | クリア ボタン。 | +| `helper-text` | ヘルパー テキスト。 | +| `list-wrapper` | ドロップダウン。 | +| `filter-input` | 検索入力のコンテナー。 | +| `search-input` | 検索入力。 | +| `case-icon` | 大文字と小文字を区別するフィルタリングを切り替えるボタン。オンの間は `active` が追加されます。 | +| `header` | `header` スロットのコンテナー。 | +| `list` | オプションのリスト。 | +| `group-header` | リスト内の各グループ ヘッダー。 | +| `item` | リスト内の各オプション。アクティブなオプションと選択されたオプションには、それぞれ `active` と `selected` が追加されます。 | +| `checkbox` | 各オプションのチェックボックス。オプションが選択されている場合は `checked` が追加されます。 | +| `checkbox-indicator` | 各オプションのチェックボックスのインジケーター。 | +| `empty` | `empty` スロットのコンテナー。 | +| `footer` | `footer` スロットのコンテナー。 | -```css -igc-combo::part(search-input) { - background-color: var(--ig-gray-100); - border-radius: 2px; + + +### Sass テーマ + +プライマリ プロパティを変更すると、関連するすべての依存プロパティが自動的に更新され、変更が反映されます。`combo-theme` 関数のプライマリ パラメーターは `$toggle-button-background` で、テーマはここからすべての状態のトグル ボタンの色を導出します。Combo、そのドロップダウン、およびそのチェックボックスのテーマを作成し、`tokens()` ミックスインでインクルードします。このミックスインは、インクルードしたスコープに、対応する CSS 変数を出力します。 + + + +```scss +@use "igniteui-angular/theming" as *; + +$custom-combo-theme: combo-theme( + $toggle-button-background: #e0e0e0 +); + +$custom-drop-down-theme: drop-down-theme( + $background-color: #e6f2ff +); + +$custom-checkbox-theme: checkbox-theme( + $fill-color: #005dcc, + $empty-color: #005dcc +); + +:host { + @include tokens($custom-combo-theme); + @include tokens($custom-drop-down-theme); + @include tokens($custom-checkbox-theme); } +``` + +Angular Combo は、ドロップダウンをオーバーレイに表示します。ビューのカプセル化とオーバーレイ アウトレットの場所によっては、`:host` 配下にインクルードしたテーマがドロップダウンに適用されない場合があります。[オーバーレイのスタイル設定](../../overlay-styling.mdx)トピックを参照してください。 + + + + + +Sass 関数は `igniteui-theming` パッケージから提供されます。Sass のセットアップについては、[テーマ](../../themes/overview.mdx)トピックを参照してください。 + +```scss +@use "igniteui-theming" as *; + +$custom-combo-theme: combo-theme( + $toggle-button-background: #e0e0e0 +); + +$custom-drop-down-theme: drop-down-theme( + $background-color: #e6f2ff +); + +$custom-checkbox-theme: checkbox-theme( + $fill-color: #005dcc, + $empty-color: #005dcc +); + +:root { + @include tokens($custom-combo-theme); + @include tokens($custom-drop-down-theme); + @include tokens($custom-checkbox-theme); +} +``` + + + +### CSS 変数 -igc-combo::part(input) { - background-color: var(--ig-gray-100); +Sass のビルド手順なしでローカルにスタイルを設定する必要がある場合は、Combo またはコンテナーに CSS 変数を設定します: + +```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; + --ig-checkbox-fill-color: #005dcc; } +``` + + -igc-combo::part(prefix) { - background-color: var(--ig-secondary-50); - color: var(--ig-primary-500); +その他のスタイルには、CSS パーツを使用します: + +```css +igc-combo::part(group-header) { + color: #005dcc; } -igc-combo::part(toggle-icon) { - color: var(--ig-primary-500); +igc-combo::part(item selected) { + color: #000; } ``` - + + + + + + + + + + + + + + +### Tailwind でのスタイル設定 +カスタム Tailwind ユーティリティ クラスを使用して、{Platform} Combo のスタイルを設定できます。最初に [Tailwind をセットアップ](../../themes/tailwind.mdx)してください。 + + + +グローバル スタイルシートに Ignite UI ユーティリティをインポートします: + +```css +@import "tailwindcss"; +@import "igniteui-theming/tailwind/utilities/material.css"; +``` + +対応するテーマには `light-combo` または `dark-combo` クラスを使用し、生成された CSS 変数を任意のプロパティでオーバーライドします: + +```html + + ... + +``` + +感嘆符 (`!`) により、Tailwind ユーティリティが Combo の既定のテーマ スタイルより優先されます。 + + + + + +Tailwind の任意のプロパティで、`--ig-combo-*`、`--ig-input-group-*`、`--ig-drop-down-*` CSS 変数を設定します: + + + + + +```html + + +``` + + + + + +```tsx + +``` + + + + + +```razor + +``` + + + + + + + + + + + + + + + +## アクセシビリティ + +{Platform} Combo は、WAI-ARIA の combobox パターンのロールを使用します。入力フィールドはオプションの `listbox` を制御する `combobox` であり、ユーザーはキーボードでリストを開き、移動し、オプションを選択します。 + +### キーボード操作 + + + +{Platform} Combo の入力フィールドはタブ ストップです。ドロップダウンが開くと、検索入力にフォーカスが移ります。`autofocusList` が設定されている場合、または検索入力が非表示の場合は、リストにフォーカスが移ります。単一選択モードでは、フォーカスは入力フィールドに留まります。Combo にフォーカスがある間は、次のキーが機能します: + +| キー | 動作 | +| --- | --- | +| Arrow Down | 入力フィールドではドロップダウンを開き、単一選択モードではフォーカスをリストに移して最初のオプションをアクティブにします。検索入力では、フォーカスをリストに移して最初のオプションをアクティブにします。リストでは、次のオプションをアクティブにします。 | +| Alt + Arrow Down | 入力フィールドでは、Arrow Down と同じ動作をします。 | +| Arrow Up | 入力フィールドでは、ドロップダウンを閉じます。検索入力では、ドロップダウンを閉じてフォーカスを入力フィールドに移します。リストでは、前のオプションをアクティブにします。最初のオプションからは、フォーカスを検索入力に移します。検索入力が非表示の場合は、ドロップダウンを閉じてフォーカスを入力フィールドに移します。 | +| Home / End | リストでは、最初または最後のオプションをアクティブにします。 | +| Space | リストでは、アクティブなオプションを選択または選択解除します。 | +| Enter | アクティブなオプションがある場合は、ドロップダウンを閉じてフォーカスを入力フィールドに移します。単一選択モードでは、アクティブなオプションも選択します。 | +| Escape | ドロップダウンが開いている場合は、ドロップダウンを閉じてフォーカスを入力フィールドに移します。ドロップダウンが閉じている場合は、選択をクリアします。 | +| Tab / Shift + Tab | ドロップダウンを閉じて、フォーカスを次または前のフォーカス可能な要素に移します。単一選択モードでは、アクティブなオプションも選択します。 | + +無効な Combo は、これらのキーを無視します。 + + + + + +Angular Combo の入力フィールドはタブ ストップです。Combo にフォーカスがある間は、次のキーが機能します: + +| キー | 動作 | +| --- | --- | +| Arrow Down / Alt + Arrow Down | 閉じている Combo では、ドロップダウンを開いてフォーカスを検索入力に移します。検索入力では、フォーカスを最初のオプションに移します。リストが空でカスタム値が許可されている場合は、項目の追加ボタンに移します。リストでは、次のオプションに移動し、最後のオプションからは、項目の追加ボタンが表示されている場合はそこに移動します。 | +| Arrow Up / Alt + Arrow Up | 検索入力では、ドロップダウンを閉じてフォーカスを Combo に移します。リストでは、前のオプションに移動します。最初のオプションからは、フォーカスを検索入力に戻します。検索入力がない場合は、ドロップダウンを閉じてフォーカスを Combo に移します。 | +| Home / End | リストでは、最初または最後のオプションに移動します。 | +| Space | リストでは、アクティブなオプションを選択または選択解除します。 | +| Enter | リストでは、選択を確定してドロップダウンを閉じます。項目の追加ボタンでは、検索入力のテキストを新しい項目として追加して選択します。 | +| Escape | ドロップダウンが開いている場合は、ドロップダウンを閉じてフォーカスを Combo に維持します。ドロップダウンが閉じている場合は、選択をクリアします。 | +| Tab | ドロップダウンを閉じて、フォーカスを次のフォーカス可能な要素に移します。 | + + + +### スクリーン リーダー / ARIA + + + +{Platform} Combo は、次のロールと属性をレンダリングします: + +| 要素 | ロール | 属性 | +| --- | --- | --- | +| 入力フィールド | `combobox` | `aria-haspopup="listbox"`、`aria-expanded`、`aria-disabled`、リストを指す `aria-controls`、およびヘルパー テキストがある場合はそれを指す `aria-describedby` | +| `list` パーツ | `listbox` | `aria-multiselectable` (単一選択モードでは `false`)、入力フィールドを指す `aria-labelledby`、およびアクティブなオプションを指す `aria-activedescendant` | +| 各 `item` パーツ | `option` | `aria-selected`、`aria-posinset`、および `aria-setsize` | +| `clear-icon` パーツ | `button` | リソース文字列からの `aria-label` | + +{Platform} Combo は、支援技術に対して次のように動作します: + +- 入力フィールドは、`label` からアクセシブル名を取得します。ラベルがない場合は、オプションが選択されているかどうかを示すリソース文字列から名前を取得します。 +- フォーカスがリストにある間、アクティブなオプションは `aria-activedescendant` を通じて読み上げられます。 +- 閉じているドロップダウンのコンテンツは `inert` です。 + + + + + +Angular Combo は、次のロールと属性をレンダリングします: + +| 要素 | ロール | 属性 | +| --- | --- | --- | +| 入力フィールドの入力 | `combobox` | `aria-haspopup="listbox"`、`aria-expanded`、リストを指す `aria-controls`、`aria-labelledby`、および `aria-label` | +| 検索入力 | `searchbox` | `aria-autocomplete="list"` および `aria-label="search"` | +| ドロップダウン | `listbox` | `igxLabel` または `ariaLabelledBy` 要素を指す `aria-labelledby` | +| オプションのコンテナー | — | `aria-multiselectable="true"`、およびアクティブなオプションを指す `aria-activedescendant` | +| 各オプション | `option` | `aria-selected` | +| 各グループ ヘッダー | `group` | — | +| 項目の追加ボタン | `button` | リソース文字列からの `aria-label` | + +入力フィールドは、`igxLabel` または 入力プロパティからアクセシブル名を取得します。これらがない場合は、オプションが選択されているかどうかを示すリソース文字列から名前を取得します。 + + + +### アクセシビリティ準拠 + +Infragistics は、{ProductName} のアクセシビリティ サポートについて、Section 508 および WCAG 2.1 のガイドライン領域を[アクセシビリティ準拠](../../interactivity/accessibility-compliance.mdx)トピックで説明しています。 + +| 基準 | コンポーネントの準拠方法 | +| --- | --- | +| [1.3.1 情報及び関係性](https://www.w3.org/WAI/WCAG21/Understanding/info-and-relationships) | `combobox`、`listbox`、`option` ロールが構造を公開し、リストには`igxLabel` または `ariaLabelledBy` 要素入力フィールドによってラベルが付けられます。 | +| [2.1.1 キーボード](https://www.w3.org/WAI/WCAG21/Understanding/keyboard) | 矢印キーでドロップダウンを開いてオプション間を移動し、Space キーでアクティブなオプションを選択します。 | +| [2.1.2 キーボード トラップなし](https://www.w3.org/WAI/WCAG21/Understanding/no-keyboard-trap) | Tab キーでドロップダウンを閉じ、フォーカスを Combo の外に移します。 | +| [4.1.2 名前 (name)・役割 (role)・値 (value)](https://www.w3.org/WAI/WCAG21/Understanding/name-role-value) | 入力フィールドは、`combobox` ロール、ラベルからの名前、および `aria-expanded` による展開状態を公開します。各オプションは、`aria-selected` による選択状態を公開します。 | + +ユーザー側の責務: + +- すべての Combo に、ユーザーが選択する内容を示すラベルを付けます。[タイプ](#タイプ)を参照してください。 +- テーマの色をオーバーライドする場合は、[1.4.11 非テキストのコントラスト](https://www.w3.org/WAI/WCAG21/Understanding/non-text-contrast)で求められているとおり、枠線とフォーカス インジケーターに 3:1 以上のコントラスト比を維持します。 +- エラー メッセージは、色だけでなくヘルパー テキストに表示します。[検証状態](#検証状態)を参照してください。 + + + +## 既知の制限事項 + +- 選択された項目を表示する入力フィールドは編集できません。Firefox では、カーソルが表示されます。 +- Angular Combo が `undefined` を含むプリミティブの配列にバインドされている場合、リストに `undefined` は表示されません。オブジェクトの `valueKey` フィールドが `undefined` の場合、リストに項目は表示されますが、ユーザーは選択できません。 +- Angular Combo がリモート サービスにバインドされていて、事前定義された選択がある場合、データが読み込まれるまで入力フィールドは空白のままです。 +- リストは[仮想スクロール](../../layouts/virtual-scroll.mdx#known-limitations)を使用するため、その制限が適用されます。リストは表示範囲内のオプションのみをレンダリングするため、DOM を照会するコードは、それらのオプションしか見つけられません。 + + ## API リファレンス +{Platform} Combo の API リファレンスには、対象プラットフォームの完全な API が記載されています。 + + + +- + + + + + +- + + + + + +- +- +- +- +- + + -
+## 依存関係 + +{Platform} Combo は、色とサイズを適用するためにテーマが必要です。フレームワーク固有のセットアップについては、[**作業の開始**](../../general/getting-started.mdx)[**作業の開始**](../../general-getting-started.mdx)を参照してください。 + + + +Angular Combo は、ドロップダウン、入力グループ、チェックボックス、アイコン、およびオーバーレイを使用します。これらのテーマが、Combo の各部分のスタイルを設定します: + +- +- +- +- +- + + + + + +`IgcComboComponent` の登録により、Combo がレンダリングする入力、アイコン、チェックボックス、ポップオーバーの各要素も登録されます。アイコンなど、Combo のスロットに配置するコンポーネントは、別途登録します。 + + + + + +Blazor Combo と、アイコンなど、そのスロットに配置するコンポーネントは、初めてレンダリングされるときにモジュールを読み込みます。[コンポーネント モジュール](../../general-getting-started.mdx#component-modules)を参照してください。 + + ## その他のリソース +次のリソースでは、{Platform} Combo に関するその他のガイダンスとプロジェクトのサポートを提供します: + + + +- [Combo の機能](../../combo-features.mdx) +- [Combo のリモート バインディング](../../combo-remote.mdx) +- [Combo のテンプレート](./templates.mdx) + + + + + +- [Combo の機能](./features.mdx) +- [Combo のテンプレート](./templates.mdx) +- [Combo の単一選択](./single-selection.mdx) + + + +- [Combo - デザイン システム コンポーネント](https://www.infragistics.com/products/indigo-design/help/components/combo) - [{ProductName} **フォーラム (英語)**]({ForumsLink}) - [{ProductName} **GitHub (英語)**]({GithubLink}) + +## 関連コンポーネント + +{Platform} Combo は、ユーザーがリストを検索して 1 つ以上のオプションを選択できるコンポーネントです。選択の動作が異なる場合は、次のコンポーネントを使用します: + +- [選択](../../select.mdx)[選択](../select.mdx) - 検索が不要な短いリストから、ユーザーが 1 つのオプションを選択する場合は、選択を使用します。 +- [ドロップダウン](../../drop-down.mdx)[ドロップダウン](../dropdown.mdx) - ボタンまたは別の要素からアクションまたはオプションのリストを表示するには、ドロップダウンを使用します。 +- [シンプル コンボ](./single-selection.mdx) - ユーザーが単一の項目を選択し、入力フィールドに入力してリストをフィルタリングしたり、カスタム値を入力したりする場合は、シンプル コンボを使用します。 + +## FAQ + +これらの質問では、{Platform} Combo の一般的なセットアップ、選択、および使用のシナリオを取り上げます。 + + + + Angular Combo を `[(ngModel)]` またはフォーム コントロールで `valueKey` の値の配列にバインドするか、項目を指定して `select` メソッドを呼び出します。`valueKey` がない場合、Angular Combo は `data` 内のオブジェクトへの参照を使用します。{Platform} Combo の `value` を `valueKey` の値の配列に設定するか、項目を指定して `select` メソッドを呼び出します。`valueKey` がない場合、{Platform} Combo は `data` 内のオブジェクトへの参照を使用します。 + + + Angular Combo では、常に複数選択が可能です。ユーザーが単一の項目を選択する必要がある場合は、シンプル コンボを使用します。入力フィールドに入力してリストをフィルタリングすることもできます。はい。{Platform} Combo に `singleSelect` を設定すると、ユーザーは検索入力ではなく入力フィールドから 1 つの項目を選択し、リストをフィルタリングします。単一選択のトピックを参照してください。 + + + {Platform} Combo の `groupKey` を、各オプションのグループを保持するフィールドに設定します。{Platform} Combo は各グループのヘッダーを表示し、グループを並べ替えます。 + + + リストが長い場合、ユーザーがリストを検索する必要がある場合、または複数のオプションを選択する場合は、{Platform} Combo を使用します。検索せずに短いリストから 1 つのオプションを選択する場合は、{Platform} 選択を使用します。 + + diff --git a/docs/xplat/src/content/jp/components/inputs/combo/single-selection.mdx b/docs/xplat/src/content/jp/components/inputs/combo/single-selection.mdx index 1c98ded924..038aa8f689 100644 --- a/docs/xplat/src/content/jp/components/inputs/combo/single-selection.mdx +++ b/docs/xplat/src/content/jp/components/inputs/combo/single-selection.mdx @@ -1,39 +1,304 @@ --- -title: "{Platform} ComboBox コンポーネント – {ProductName}" -description: "{Platform} Combo コンポーネントは、基本的な HTML 入力、選択、フィルタリング、およびカスタム ドロップダウン リストの機能を組み合わせた強力な入力を提供します。無料でお試しください。" -keywords: "{ProductName}, UI コントロール, {Platform} ウィジェット, web ウィジェット, UI ウィジェット, {Platform}, ネイティブ {Platform} コンポーネント スイート, ネイティブ {Platform} コントロール, ネイティブ {Platform} コンポーネント ライブラリ, {Platform} ComboBox コンポーネント" +title: "{Platform} Single Selection Combo コンポーネント" +description: "{ProductName} Single Selection Combo は、ユーザーが 1 つのオプションを選択し、入力フィールドに入力して検索可能なドロップダウン リストをフィルタリングできる Combo です。" +keywords: "{Platform} Single Selection Combo, {ProductName}, 単一選択コンボ, シンプル コンボ, コンボボックス, 検索可能なドロップダウン, コンボのフィルタリング" license: MIT -mentionedTypes: ["Combo", "SingleSelect", "ComboItem", "ComboHeader", "ComboList"] +last_updated: "2026-11-05" +relatedComponents: ["Combo", "Select", "Dropdown"] +mentionedTypes: ["Combo", "ComboItem", "ComboHeader", "ComboList"] _language: ja llms: - description: "{Platform} ComboBox は、単一選択モードと、メインの入力プロンプトを介した項目リストのクイック フィルタリングをサポートしています。" + description: "{ProductName} Single Selection Combo は、ユーザーが 1 つのオプションを選択し、入力フィールドに入力して検索可能なドロップダウン リストをフィルタリングできる Combo です。" --- import PlatformBlock from 'igniteui-astro-components/components/mdx/PlatformBlock.astro'; import Sample from 'igniteui-astro-components/components/mdx/Sample.astro'; import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro'; +import Anatomy from 'igniteui-astro-components/components/mdx/Anatomy.astro'; +import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'; +import DoDont from 'igniteui-astro-components/components/mdx/DoDont.astro'; +import Faq from 'igniteui-astro-components/components/mdx/Faq.astro'; +import FaqItem from 'igniteui-astro-components/components/mdx/FaqItem.astro'; +import comboAnatomy from '@xplat-images/anatomy-content-light/single-select-combo-lt-a.png'; +import comboDoAlignment from '@xplat-images/combo/single-select-combo-do-1.png'; +import comboDoNotAlignment from '@xplat-images/combo/single-select-combo-do-not-1.png'; +# Single Selection Combo (単一選択コンボ) +{ProductName} Single Selection Combo は、ユーザーが 1 つのオプションを選択し、入力フィールドに入力して検索可能なドロップダウン リストをフィルタリングできる Combo です。 -# {Platform} 単一選択 ComboBox + -{Platform} `ComboBox` は、単一選択モードと、メインの入力プロンプトを介した項目リストのクイック フィルタリングをサポートしています。ユーザーは、数文字タイプすることで、オプションのリストに探している項目を表示できます。Enter キーを押すと、最初にハイライト表示された一致が選択されます。 +Angular の単一選択 Combo は Simple Combo (`igx-simple-combo` コンポーネント) です。Combo と同様にオプションのバインド、グループ化、テンプレート化ができ、ユーザーは入力フィールドに入力してリストをフィルタリングしたり、カスタム値を入力したりできます。 -## {Platform} 単一選択の例 + + + + +{Platform} Combo で を設定すると、単一選択に切り替わります。入力フィールドが編集可能になり、ユーザーの入力に応じてリストがフィルタリングされます。ドロップダウンの検索入力は非表示になり、オプションにチェックボックスは表示されません。 + + + + +Combo には 2 つのレイアウト オプションがあります。単一選択の Combo (Simple Combo) と Combo (複数選択) です。 + + +## ライブ デモ + + + + + + + + + + + + + +## 構造 + +Simple Combo は 2 つの要素で構成されます。現在の選択項目またはプレースホルダーを含む入力と、定義済みのドロップダウン リストからオプションを選択するために表示されるドロップダウンです。 + + + + + +1. 入力コンテナー: 値と入力要素を表示します
+2. ラベル (オプション): ユーザーが何を選択するかを説明するテキストです
+3. 左アイコン (オプション): フィールドに文脈を追加する、先頭のオプション アイコンです
+4. ヒント テキスト: 追加のガイダンスとしてフィールドの下に表示されるヘルパー テキストです
+5. プレースホルダー テキスト: 値が選択されていないときに表示される既定のテキストです
+6. トグル: オプション リストを開閉するために使用します
+7. ドロップダウン ヘッダー: ドロップダウンのオプションをグループ化または説明するために使用します
+8. 選択項目: ドロップダウン リストから選択された項目です
+9. ドロップダウン リスト: 選択可能なオプションのリストを表示します
+ + + +単一選択モードでは、`igc-combo` 要素は編集可能な入力フィールドをレンダリングし、ドロップダウンの検索入力を非表示にして、チェックボックスなしでオプションをレンダリングします。 + +```text +igc-combo[single-select] +└─ #shadow-root + ├─ igc-popover + │ ├─ igc-input#target[slot="anchor"] // the editable input field, exported as the "input" part + │ │ ├─ slot[name="prefix"] + │ │ ├─ span[part="clear-icon"] // shown when the Combo has a value + │ │ ├─ slot[name="suffix"] + │ │ └─ span[part="toggle-icon"] + │ └─ div[part="list-wrapper"] // the dropdown + │ ├─ div[part="filter-input"][hidden] // the search input is hidden + │ ├─ div[part="header"] + │ │ └─ slot[name="header"] + │ ├─ igc-virtual-scroll#dropdown[part="list"][role="listbox"] + │ │ ├─ igc-combo-header[part="group-header"] // one for each group + │ │ └─ igc-combo-item[part="item"][hide-checkbox] // one for each option + │ ├─ div[part="empty"] // shown when the list has no options + │ │ └─ slot[name="empty"] + │ └─ div[part="footer"] + │ └─ slot[name="footer"] + └─ igc-validator[part="helper-text"] // the helper text and the validation messages +``` + + + + + +`igx-simple-combo` 要素は、入力グループ内に編集可能な入力フィールドを、オーバーレイ内にドロップダウン リストをレンダリングします。検索入力はありません。 + +```text +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 +``` + + + +## はじめに -単一選択とクイック フィルタリングを有効にするには、 で プロパティを設定します。ユーザー エクスペリエンスとキーボード ナビゲーションはほとんど変わりませんが、オプション リストの上にある特別なフィルター ボックスに検索クエリを入力する代わりに、メインの入力ボックスが使用されます。 +{Platform} Single Selection Combo を使用するには、基本的なプロジェクト セットアップについて [{ProductName} はじめに](../../general/getting-started.mdx)[{ProductName} はじめに](../../general-getting-started.mdx) トピックに従い、対象のプラットフォーム向けにコンポーネントを追加します。 + + + +単一選択モードは Combo のモードであるため、パッケージ、登録、およびテーマ CSS は [Combo](./overview.mdx#getting-started) のものと同じです。 + + +**{PackageCommon}** パッケージをインストールします。 + +```cmd +npm install {PackageCommon} +``` + +次に、、そのテーマ CSS をインポートし、コンポーネントを登録します。 + +```ts +import { defineComponents, IgcComboComponent } from 'igniteui-webcomponents'; +import 'igniteui-webcomponents/themes/light/bootstrap.css'; + +defineComponents(IgcComboComponent); +``` + +`single-select` 属性を指定して Combo をレンダリングし、`data` をバインドします。 + ```html - + +``` + +```ts +const combo = document.getElementById('countries') as IgcComboComponent; + +combo.data = [ + { id: 'BY', name: 'Belarus' }, + { id: 'BE', name: 'Belgium' }, + { id: 'BG', name: 'Bulgaria' } +]; +``` + + + + + +**{PackageCommon}** パッケージをインストールします。 + +```cmd +npm install {PackageCommon} +``` + +次に、 ラッパーとテーマ CSS をインポートし、`singleSelect` を指定して Combo をレンダリングします。 + +```tsx +import { IgrCombo } from 'igniteui-react'; +import 'igniteui-webcomponents/themes/light/bootstrap.css'; + +const countries = [ + { id: 'BY', name: 'Belarus' }, + { id: 'BE', name: 'Belgium' }, + { id: 'BG', name: 'Bulgaria' } +]; + + ``` +{ProductName} サービスを登録します。 + +```csharp +// in Program.cs file + +builder.Services.AddIgniteUIBlazor(); +``` + + のクライアント リソース モジュールである の登録は**オプション**です。コンポーネントは最初のレンダリング時にリソースを読み込みます。[コンポーネント モジュール](../../general-getting-started.mdx#component-modules)を参照してください。 + +次に、アプリのホスト ページでテーマ CSS ファイルをリンクし、`SingleSelect` を指定して Combo をレンダリングします。 + ```razor - + +``` + +```razor + + +@code { + private class Country + { + public string Id { get; set; } + public string Name { get; set; } + } + + private List Countries = new() + { + new Country { Id = "BY", Name = "Belarus" }, + new Country { Id = "BE", Name = "Belgium" }, + new Country { Id = "BG", Name = "Bulgaria" } + }; +} +``` + + + + + +プロジェクトで {ProductName} をまだ使用していない場合は、`ng add igniteui-angular` を実行します。次に、`IGX_SIMPLE_COMBO_DIRECTIVES` トークンをインポートし、コンポーネントの `imports` に追加します。このトークンには とそのテンプレート ディレクティブが含まれています。 + +```ts +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: ` + + `, + imports: [IGX_SIMPLE_COMBO_DIRECTIVES] +}) +export class HomeComponent { + public countries = [ + { id: 'BY', name: 'Belarus' }, + { id: 'BE', name: 'Belgium' }, + { id: 'BG', name: 'Bulgaria' } + ]; +} +``` + + + +## 使用方法 + +国や都市など、ユーザーが検索する必要があるリストから 1 つのオプションだけを選ぶ場合は、{Platform} Single Selection Combo を使用します。 + +### タイプ + +Simple Combo の入力では、単色の背景上でより構造的に見える境界線タイプと、鮮やかな画像の上に配置したときに読みやすさを高めるのに最適なボックス タイプのどちらかを選択できます。 + + + +{Platform} Combo は既定でボックス タイプを使用します。境界線タイプにするには `outlined` を設定します。ボックス タイプは Material テーマのスタイルであり、Bootstrap、Fluent、Indigo テーマでは両方のタイプが同じ見た目になります。 + + + + + +```html + + ``` @@ -41,131 +306,1192 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro'; ```tsx - + + +``` + + + + + +```razor + + ``` - + +Angular Simple Combo は既定でボックス タイプを使用します。境界線タイプにするには、 入力を `border` に設定します。ラベルは `igxLabel` ディレクティブで、左アイコンは `igx-prefix` で追加します。 +```html + + + language + + + + + +``` + + -## 選択 API + - プロパティが適用された ComboBox の選択 API はほとんど同じままですが、このプロパティが設定されていない ComboBox と比べて重要な違いがいくつかあります。 +ラベルは `label` プロパティで、左アイコンは `prefix` スロットで追加します。アイコンは、[アイコン](../../layouts/icon.mdx)トピックで説明されているように、先に登録します。 -主な違いは、一度に 1 つの項目しか選択できないことです。たとえば、コンボ コンポーネントに を指定した場合、複数の項目を / メソッドに渡しても効果はありません。これは、以前に選択した項目が、新しい選択を行うと自動的に選択解除されることも意味します。 + -単一の選択コンボでプログラムによって項目を選択 / 選択解除する方法は次のとおりです。 + -### 項目の選択 + + - + + -```ts -// select the item matching the 'BG01' value of the value key field. -combo.select('BG01'); + + +### 無効状態 + +{Platform} Single Selection Combo で `disabled` を設定すると、境界線タイプとボックス タイプの両方の無効状態が表示されます。 + + + +```html + ``` + + +```tsx + +``` + + ```razor - + +``` -@code { - private IgbCombo Combo; + - this.Combo.Select(new object[] { "UK01" }); -} + + +```html + ``` + - + + -```tsx -// select the item matching the 'BG01' value of the value key field. -comboRef.current.select('BG01'); + + + + + + +### サイズ + +Combo には、大、中、小の 3 つのサイズがあります。ドロップダウンは、選択したサイズに合わせて自動的に寸法を調整します。サイズは `--ig-size` CSS 変数で設定します。 + +```css +.small { + --ig-size: var(--ig-size-small); +} + +.large { + --ig-size: var(--ig-size-large); +} ``` + + +{Platform} Combo は既定で中サイズです。 + + + + -新たに選択せずに項目の選択を解除するには、 メソッドを呼び出します。 + -#### 項目の選択解除 + + - + + +### インタラクション状態 + +Combo コンポーネントは、有効なバリアントに対して 5 つの状態 (アイドル、アイドル & ホバー、入力済み、入力済み & ホバー、フォーカス) と、3 つの検証状態 (成功、警告、エラー) をサポートします。 + +入力フィールドまたはトグルをクリックするとドロップダウンが開き、入力フィールドに入力するとドロップダウンが開いてリストがフィルタリングされます。コードでドロップダウンを開閉するには、`open` プロパティ、または `show`、`hide`、`toggle` メソッド`Open` パラメーター、または `ShowAsync`、`HideAsync`、`ToggleAsync` メソッド`open`、`close`、`toggle` メソッドを使用します。 + ```ts -// deselect the item matching the 'BG01' value of the value key field. -combo.deselect('BG01'); +const combo = document.querySelector('igc-combo'); + +await combo.show(); +await combo.hide(); +await combo.toggle(); ``` + + +```tsx +const comboRef = useRef(null); + +comboRef.current.show(); +comboRef.current.hide(); +comboRef.current.toggle(); +``` + + ```razor - + @code { - private IgbCombo Combo; + private IgbCombo Combo; + + private async Task OpenAsync() => await Combo.ShowAsync(); +} +``` + + + + + +```ts +@ViewChild(IgxSimpleComboComponent, { static: true }) +public combo: IgxSimpleComboComponent; - this.Combo.Deselect(new object[] { "UK01" }); +public openCombo(): void { + this.combo.open(); } ``` +次のサンプルでは、各状態を並べて表示します。ホバーとフォーカスはポインターとキーボードによって発生するため、このサンプルでは、表示専用の Combo のこれらの状態を CSS クラスでスタイル設定しています。 + + + + + + + + + + + + + +### 検証状態 + +経験豊富なデザイナーは、ユーザー入力を制限して無効な状態を避けるために制約を適切に使用します。そのため、検証スタイルが用意されています。利用可能な検証スタイルにより、Combo の入力は標準の [入力](../../input-group.mdx)[入力](../input.mdx)と一貫性を保ち、成功、警告、エラーの視覚表現を表示する高度なデザインにも対応できます。 + + + +{Platform} Combo はフォームに関連付けられます。選択項目を必須にするには `required` を、エラー状態を表示するには `invalid` を設定します。ガイダンスまたはエラー メッセージは `helper-text` スロットに配置します。単一選択モードでは、フォームの値は選択項目の `valueKey` の値です。Combo には成功状態や警告状態が組み込まれていないため、サンプルではこれら 2 つの状態を CSS クラスでスタイル設定しています。 + + + + + +```html + + Please select a different region + +``` + + +```tsx + + Please select a different region + +``` + + + + + +```razor + + Please select a different region + +``` + + + + + +Angular Simple Combo は、バインドされているフォーム コントロール (`ngModel` またはリアクティブ フォーム) から検証状態を取得します。コードで状態を設定するには、 プロパティに `IgxInputState` の値を設定します。ガイダンスまたはエラー メッセージは `igx-hint` に配置します。 + +```html + + Please select a different region + +``` + + + + + + + + + + + + + + + +### ドロップダウン サイズ + +Combo に使用されるドロップダウンは、通常の [ドロップダウン](../../drop-down.mdx)[ドロップダウン](../dropdown.mdx)コンポーネントと同様に、大、中、小の Combo に適したサイズで提供されます。ドロップダウンは Combo からサイズを取得するため、`--ig-size` 変数は Combo に設定します。 + + + +Angular Simple Combo は、項目とリストの高さを設定するための 入力と 入力も公開しています。 + +```html + +``` + + + +次のサンプルでは、入力フィールドを除いたドロップダウンのみを表示します。 + + + + + + + + + + + + + +### ドロップダウン項目 + +Simple Combo に使用されるドロップダウンは、ヘッダーと単一選択項目の 2 種類の項目をサポートします。どちらも大、中、小のサイズで利用できます。ヘッダーを使用すると、項目をグループに整理できます。 + +各オプションのグループを保持するフィールドに `groupKey` を設定すると、{Platform} Single Selection Combo はグループごとにヘッダーを表示します。単一選択モードのオプションにはチェックボックスが表示されません。項目とヘッダーの内容を変更するには、[Combo テンプレート](./templates.mdx)トピックを参照してください。 + + + +```html + +``` + + + + ```tsx -// deselect the item matching the 'BG01' value of the value key field. -comboRef.current.deselect('BG01'); + +``` + + + + + +```razor + ``` + + +```html + +``` -## 無効な機能 + -当然のことながら、一部の構成オプションは単一選択 ComboBox では効果がありません。 +次のサンプルでは、各サイズのヘッダーと項目を表示します。 -### プレースホルダー + - プロパティに値を割り当てても結果は得られません。これは、通常、オプションのリストの上に配置されるフィルター入力が単一の選択 ComboBox に存在しないためです。 + -### オプション リストのオートフォーカス + -単一選択 ComboBox に オプションを設定しても効果はありません。 + -## キーボード ナビゲーション + -キーボード ナビゲーションは、非単一選択 ComboBox と同じように動作しますが、メイン入力がフィルタリング プロンプトの役割を果たし、フィルタリング / 検索入力に適用されるすべてのキーボード アクションがメイン入力プロンプトに移動される点が異なります。 + -## その他の機能 +### ドロップダウン項目の状態 -他のすべての機能は、非単一選択 ComboBox コンポーネントと同じように動作します。 +{Platform} Single Selection Combo のドロップダウンの項目は、アイドル、ホバー、フォーカスのいずれかの状態になり、各状態には選択済みのバリアントがあります。ドロップダウン テーマには、無効な項目用の色も含まれています。 +次のサンプルでは、各状態を並べて表示します。ホバーとフォーカスはポインターとキーボードによって発生するため、このサンプルでは、表示専用の項目のこれらの状態を CSS クラスでスタイル設定しています。 -## API リファレンス + -
+ -## その他のリソース +
-- [{ProductName} **フォーラム (英語)**]({ForumsLink}) -- [{ProductName} **GitHub (英語)**]({GithubLink}) + + + + + + +### データ バインディング + +{Platform} Single Selection Combo は、Combo と同じ方法でオプションをバインドします。`data` を配列にバインドし、配列がオブジェクトを保持する場合は `valueKey`、`displayKey`、`groupKey` を設定します。Combo トピックの[データ バインディング](./overview.mdx#data-binding)を参照してください。 + + + +Angular Simple Combo は、リモート サービスにもバインドでき、データをオンデマンドで読み込みます。`data` を読み込まれたチャンクにバインドし、[Combo リモート バインディング](../../combo-remote.mdx)トピックで説明されているように、 イベントを処理して次のチャンクを読み込みます。 + + + +### 値と選択 + +{Platform} Single Selection Combo は 1 つの選択項目を保持し、その値と選択 API を通じて公開します。 + + + +`value` は、選択項目を 1 要素の配列として保持します。要素は、その `valueKey` の値、または `valueKey` がない場合はオブジェクト参照です。Combo が最初にレンダリングされるときに項目を選択するには、これを設定します。`select` メソッドは 1 つの項目を選択して前の項目の選択を解除するため、1 つの項目を渡します。`deselect` メソッドは選択を解除します。項目を指定せずに呼び出すと、単一選択モードでは `select` が選択をクリアします。 + + + + + +```ts +// select the item matching the 'BG' value of the value key field +combo.select('BG'); + +// deselect it +combo.deselect('BG'); + +console.log(combo.value); // ['BG'] while Bulgaria is selected, [] after the deselection +``` + + + + + +```tsx +// select the item matching the 'BG' value of the value key field +comboRef.current.select('BG'); + +// deselect it +comboRef.current.deselect('BG'); + +console.log(comboRef.current.value); // ['BG'] while Bulgaria is selected, [] after the deselection +``` + + + + + +```razor + + +@code { + private IgbCombo Combo; + + public void SelectBulgaria() => Combo.Select(new object[] { "BG" }); + + public void DeselectBulgaria() => Combo.Deselect(new object[] { "BG" }); +} +``` + + + + + +Combo は、ユーザーが選択を変更する前に `igcChange``onChange``Change` を発行します。その詳細には、新しい値、変更された項目、および変更の種類が含まれており、このイベントをキャンセルすると選択は維持されます。 + + + + + +Angular Simple Combo は `[(ngModel)]` による双方向バインディングをサポートし、テンプレート駆動フォームとリアクティブ フォームで動作します。バインドされる値は 1 つの項目で、その `valueKey` の値、または `valueKey` がない場合はオブジェクト参照です。 プロパティは選択項目を返し、 メソッドは項目を選択し、 メソッドは選択をクリアします。 + +```html + +``` + +```ts +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` で `cancel` を設定すると選択は維持されます。 + +```html + +``` + +```ts +public onCountryChanging(event: ISimpleComboSelectionChangingEventArgs): void { + if (event.newValue === 'BY') { + event.cancel = true; + } +} +``` + +`selectionChanging` イベントは、ある Simple Combo の選択が次の Simple Combo のデータを読み込む、たとえば国、地域、都市の Combo のようなカスケード シナリオでも使用されます。各 Simple Combo の `selectionChanging` イベントを処理して、次の Combo のデータを読み込み、その選択をクリアします。 + +```html + + + + + + +``` + +```ts +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 を使用したグリッド](../../grid/cascading-combos.mdx)トピックでは、データ グリッドのセル編集で同じシナリオを示します。 + + + +### フィルタリング + +{Platform} Single Selection Combo の入力フィールドに入力すると、ドロップダウンが開き、入力したテキストを含むオプションにリストがフィルタリングされます。最初の一致がアクティブなオプションになるため、Enter キーで選択できます。 + + + +ユーザーの入力中にリスト全体を維持するには、`disableFiltering` を設定します。`filteringOptions` オブジェクトは、テキストでフィルタリングするキー、および大文字と小文字を区別するかどうか、ダイアクリティカル マークを照合するかどうかを設定します。テキストがどのオプションにも一致せず Combo がフォーカスを失うと、入力フィールドはクリアされます。 + + + + + +```ts +combo.filteringOptions = { filterKey: 'name', caseSensitive: false, matchDiacritics: true }; +``` + + + + + +```tsx + +``` + + + + + +```razor + +``` + + + + + +ユーザーの入力中にリスト全体を維持するには を設定し、大文字と小文字を区別するフィルタリングを切り替えるボタンを入力フィールドに表示するには を設定します。 入力は、テキストでフィルタリングするキーと、大文字と小文字を区別するかどうかを設定し、 はフィルタリングを独自の処理に置き換えます。テキストがどのオプションにも一致せず Simple Combo がフォーカスを失うと、入力フィールドはクリアされます。 + +```html + + +``` + +リストにない値をユーザーが入力できるようにするには、 を設定します。テキストがどのオプションにも一致しない場合、ドロップダウンに項目追加ボタンが表示され、そのボタンで Enter キーを押すと、テキストが新しい項目として追加されて選択されます。Simple Combo は、項目を追加する前に を発行します。 + +```html + +``` + + + +### 推奨 / 非推奨 + +Simple Combo を使用する場合、その入力とドロップダウンは同じ幅にし、左右の境界線を揃える必要があります。Simple Combo にフォーカスが当たったときのドロップダウンの表示方法については、表示をトリガーする Simple Combo の後に続くコンテンツの上に常に表示する必要があります。Combo は、展開パネルのようにコンテンツを押し下げることはありません。 + + + + +入力とドロップダウンを揃え、同じ幅と一致する左右の境界線にします。 + + + + +入力よりも狭いドロップダウンや、位置がずれたドロップダウンは、両者の視覚的なつながりを損なうため避けてください。 + + + + +## プロパティ + +{Platform} Single Selection Combo は次のプロパティを公開します。単一選択モードは Combo のモードであるため、完全なセットについては [Combo](./overview.mdx#properties) トピックを参照してください。完全な型定義については API リファレンスを参照してください。 + + + +| 名前 | 型 | 既定値 | 説明 | +| --- | --- | --- | --- | +| | `boolean` | `false` | ユーザーが 1 つの項目を選択し、入力フィールドからリストをフィルタリングするかどうか。 | +| | `T[]` | `[]` | Combo のオプション。 | +| | `string` | — | オプションを識別するフィールド。 | +| | `string` | — | リストと入力フィールドに表示するフィールド。`valueKey` にフォールバックします。 | +| | `string` | — | オプションをグループ化するフィールド。 | +| | `ComboValue[]` | `[]` | 選択項目。1 つの `valueKey` の値または 1 つのオブジェクト参照を持つ配列。 | +| | `string` | — | Combo のラベル。 | +| | `string` | — | 項目が選択されていないときに入力フィールドに表示されるテキスト。 | +| | `boolean` | `false` | Combo が境界線タイプを使用するかどうか。 | +| `open` | `boolean` | `false` | ドロップダウンが開いているかどうか。 | +| `disabled` | `boolean` | `false` | Combo が無効かどうか。 | +| `required` | `boolean` | `false` | Combo が有効になるために選択項目を必要とするかどうか。 | +| `invalid` | `boolean` | `false` | Combo が無効状態を表示するかどうか。 | +| | `boolean` | `false` | 入力フィールドへの入力時にリストをフィルタリングしないかどうか。 | +| | `FilteringOptions` | — | テキストでフィルタリングするキー、および大文字と小文字を区別するかどうか、ダイアクリティカル マークを照合するかどうか。 | +| | `boolean` | `false` | クリア ボタンを非表示にするかどうか。 | +| | `T[]` | — | 読み取り専用。`data` のオブジェクトとしての選択項目で、1 要素の配列。 | + + + + + +| 名前 | 型 | 既定値 | 説明 | +| --- | --- | --- | --- | +| | `bool` | `false` | ユーザーが 1 つの項目を選択し、入力フィールドからリストをフィルタリングするかどうか。 | +| | `object` | — | Combo のオプション。 | +| | `string` | — | オプションを識別するフィールド。 | +| | `string` | — | リストと入力フィールドに表示するフィールド。`ValueKey` にフォールバックします。 | +| | `string` | — | オプションをグループ化するフィールド。 | +| | `T[]` | — | 選択項目。1 要素の配列。 | +| | `string` | — | Combo のラベル。 | +| | `string` | — | 項目が選択されていないときに入力フィールドに表示されるテキスト。 | +| | `bool` | `false` | Combo が境界線タイプを使用するかどうか。 | +| | `bool` | `false` | ドロップダウンが開いているかどうか。 | +| | `bool` | `false` | Combo が無効かどうか。 | +| | `bool` | `false` | Combo が有効になるために選択項目を必要とするかどうか。 | +| | `bool` | `false` | Combo が無効状態を表示するかどうか。 | +| | `bool` | `false` | 入力フィールドへの入力時にリストをフィルタリングしないかどうか。 | +| | `bool` | `false` | クリア ボタンを非表示にするかどうか。 | + + + + + +| 名前 | 型 | 既定値 | 説明 | +| --- | --- | --- | --- | +| | `any[]` | — | Simple Combo のオプション。 | +| | `string` | — | オプションを識別するフィールド。 | +| | `string` | — | リストと入力フィールドに表示するフィールド。`valueKey` にフォールバックします。 | +| | `string` | — | オプションをグループ化するフィールド。 | +| | `IgxInputGroupType` | `'box'` | 入力フィールドのタイプ。`box`、`border`、または `line`。 | +| | `string` | — | 項目が選択されていないときに入力フィールドに表示されるテキスト。 | +| | `boolean` | `false` | Simple Combo が無効かどうか。 | +| | `boolean` | `false` | 入力フィールドへの入力時にリストをフィルタリングしないかどうか。 | +| | `boolean` | `false` | 大文字と小文字を区別するフィルタリングを切り替えるボタンを入力フィールドに表示するかどうか。 | +| | `IComboFilteringOptions` | — | テキストでフィルタリングするキー、および大文字と小文字を区別するかどうか。 | +| | `boolean` | `false` | ユーザーが入力フィールドのテキストを新しい項目として追加できるかどうか。 | +| | `boolean` | `false` | クリア ボタンを非表示にするかどうか。 | +| | `number` | — | リスト内の項目の高さ。 | +| | `number` | — | リストの最大高さ。 | +| | `IgxInputState` | `INITIAL` | Simple Combo の検証状態。 | +| | `any` | — | 読み取り専用。選択項目。 | +| | `any` | — | 読み取り専用。選択項目の `valueKey` の値。`valueKey` がない場合は項目。 | + + + +## メソッド + +{Platform} Single Selection Combo は次のメソッドを公開します。 + + + +| メソッド | 説明 | +| --- | --- | +| | 渡された項目を `valueKey` の値または参照で選択し、前の項目の選択を解除します。何も渡さない場合は選択をクリアします。 | +| | 渡された項目を `valueKey` の値または参照で選択解除します。 | +| `show` | ドロップダウンを開きます。 | +| `hide` | ドロップダウンを閉じます。 | +| `toggle` | ドロップダウンが閉じているときは開き、開いているときは閉じます。 | +| `checkValidity` | Combo が検証制約を満たしているかどうかを返します。 | +| `reportValidity` | Combo の有効性を確認し、失敗した場合は無効状態を表示します。 | + + + + + +| メソッド | 説明 | +| --- | --- | +| | 渡された項目を選択し、前の項目の選択を解除します。空の配列を渡した場合は選択をクリアします。 | +| | 渡された項目を選択解除します。 | +| | ドロップダウンを開きます。 | +| | ドロップダウンを閉じます。 | +| | ドロップダウンが閉じているときは開き、開いているときは閉じます。 | + + + + + +| メソッド | 説明 | +| --- | --- | +| | 渡された項目を選択し、前の項目の選択を解除します。 | +| | 選択をクリアします。 | +| | ドロップダウンを開きます。 | +| | ドロップダウンを閉じます。 | +| | ドロップダウンが閉じているときは開き、開いているときは閉じます。 | + + + +## イベント + +{Platform} Single Selection Combo は次のイベントを発行します。 + + + +| 名前 | 説明 | +| --- | --- | +| `igcChange` | ユーザーが選択を変更する前に発行されます。イベントの詳細には、新しい値、変更された項目、および変更の種類が含まれます。選択を維持するには、イベントをキャンセルします。 | +| `igcOpening` | ユーザーがドロップダウンを開く前に発行されます。キャンセル可能です。 | +| `igcOpened` | ユーザー操作でドロップダウンが開いた後に発行されます。 | +| `igcClosing` | ユーザーがドロップダウンを閉じる前に発行されます。キャンセル可能です。 | +| `igcClosed` | ユーザー操作でドロップダウンが閉じた後に発行されます。 | + + + + + +| 名前 | 説明 | +| --- | --- | +| | 選択が変更される前に とともに発行されます。選択を維持するには `cancel` を設定します。 | +| | 選択が確定した後に とともに発行されます。 | +| | ドロップダウンが開く前に発行されます。キャンセル可能です。 | +| | ドロップダウンが開いた後に発行されます。 | +| | ドロップダウンが閉じる前に発行されます。キャンセル可能です。 | +| | ドロップダウンが閉じた後に発行されます。 | +| | 入力フィールドのテキストが変更されたときに発行されます。 | +| | ユーザーがリストにカスタム値を追加する前に発行されます。 | +| | リモート バインディングで、リストがまだ読み込まれていないオプションまでスクロールされたときに発行されます。 | + + + +## スタイル設定 + +Simple Combo は、入力とドロップダウンの両方の要素を組み合わせた柔軟なスタイル設定を提供します。入力テキスト要素の色、境界線のスタイルと色のオプションがあります。ドロップダウンについては、背景色を変更したり、Simple Combo ドロップダウン内の項目に関するさまざまなオプションで背景色とテキスト色を変更したりできます。 + +{Platform} 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-*` 変数は効果がありません。 + + + +`igc-combo` 要素は、単一選択モードで次の CSS パーツを公開します。 + +| パーツ | スタイル設定の対象 | +| --- | --- | +| `input` | 入力フィールド。 | +| `native-input` | 入力フィールドのネイティブ入力。 | +| `label` | ラベル。 | +| `prefix` | `prefix` スロットのコンテナー。 | +| `suffix` | `suffix` スロットのコンテナー。 | +| `toggle-icon` | トグル ボタン。Combo に値があるときは `filled` が追加されます。 | +| `clear-icon` | クリア ボタン。 | +| `helper-text` | ヘルパー テキスト。 | +| `list-wrapper` | ドロップダウン。 | +| `header` | `header` スロットのコンテナー。 | +| `list` | オプションのリスト。 | +| `group-header` | リスト内の各グループ ヘッダー。 | +| `item` | リスト内の各オプション。アクティブなオプションと選択されたオプションには、それぞれ `active` と `selected` が追加されます。 | +| `empty` | `empty` スロットのコンテナー。 | +| `footer` | `footer` スロットのコンテナー。 | + + + +### Sass テーマ + +プライマリ プロパティを変更すると、関連するすべての依存プロパティが自動的に更新され、変更が反映されます。`combo-theme` 関数のプライマリ パラメーターは `$toggle-button-background` で、テーマはこれからすべての状態のトグル ボタンの色を導出します。Combo とそのドロップダウンのテーマを作成し、`tokens()` ミックスインでインクルードします。このミックスインは、インクルードしたスコープに対応する CSS 変数を出力します。 + + + +```scss +@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` の下にインクルードしたテーマがドロップダウンに適用されない場合があります。[オーバーレイのスタイル設定](../../overlay-styling.mdx)トピックを参照してください。 + + + + + +Sass 関数は `igniteui-theming` パッケージに含まれています。Sass のセットアップについては、[テーマ](../../themes/overview.mdx)トピックを参照してください。 + +```scss +@use "igniteui-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 +); + +:root { + @include tokens($custom-combo-theme); + @include tokens($custom-drop-down-theme); +} +``` + + + +### CSS 変数 + +Sass のビルド ステップなしでローカルにスタイルを設定する場合は、Combo またはコンテナーに CSS 変数を設定します。 + +```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; +} +``` + + + +その他のスタイルには CSS パーツを使用します。 + +```css +igc-combo::part(group-header) { + color: #005dcc; +} + +igc-combo::part(item selected) { + color: #000; +} +``` + + + + + + + + + + + + + + + +### Tailwind によるスタイル設定 + +カスタム Tailwind ユーティリティ クラスを使用して、{Platform} Single Selection Combo のスタイルを設定できます。最初に [Tailwind をセットアップ](../../themes/tailwind.mdx)してください。 + + + +グローバル スタイルシートで Ignite UI ユーティリティをインポートします。 + +```css +@import "tailwindcss"; +@import "igniteui-theming/tailwind/utilities/material.css"; +``` + +対応するテーマには `light-combo` または `dark-combo` クラスを使用し、生成された CSS 変数を任意のプロパティでオーバーライドします。 + +```html + + ... + +``` + +感嘆符 (`!`) は、Simple Combo の既定のテーマ スタイルよりも Tailwind ユーティリティを優先させます。 + + + + + +Tailwind の任意のプロパティで `--ig-combo-*`、`--ig-input-group-*`、`--ig-drop-down-*` CSS 変数を設定します。 + + + + + +```html + + +``` + + + + + +```tsx + +``` + + + + + +```razor + +``` + + + + + + + + + + + + + + + +## アクセシビリティ + +{Platform} Single Selection Combo は、WAI-ARIA コンボボックス パターンのロールを使用します。編集可能な入力フィールドはオプションの `listbox` を制御する `combobox` であり、ユーザーは入力でリストをフィルタリングし、キーボードでオプションを選択します。 + +### キーボード操作 + + + +{Platform} Single Selection Combo の入力フィールドはタブ ストップであり、ユーザーが入力している間もフォーカスは入力フィールドに留まります。Combo にフォーカスがある間は、次のキーが機能します。 + +| キー | 操作 | +| --- | --- | +| 印字可能な文字 | 入力フィールドで、ドロップダウンを開き、リストをフィルタリングし、最初の一致をアクティブにします。 | +| Arrow Down / Alt + Arrow Down | 入力フィールドでは、ドロップダウンを開き、フォーカスをリストに移動し、最初のオプションをアクティブにします。リストでは、次のオプションをアクティブにします。 | +| Arrow Up | 入力フィールドでは、ドロップダウンを閉じます。リストでは、前のオプションをアクティブにします。最初のオプションからは、ドロップダウンを閉じてフォーカスを入力フィールドに移動します。 | +| Home / End | リストで、最初または最後のオプションをアクティブにします。 | +| Space | リストで、アクティブなオプションを選択し、選択済みの場合は選択を解除します。 | +| Enter | アクティブなオプションがある場合、それを選択し、ドロップダウンを閉じて、テキストを選択した状態でフォーカスを入力フィールドに移動します。 | +| Escape | ドロップダウンが開いているときは、閉じてフォーカスを入力フィールドに移動します。ドロップダウンが閉じているときは、選択をクリアします。 | +| Tab / Shift + Tab | ドロップダウンが開いているときは、アクティブなオプションを選択し、ドロップダウンを閉じて、フォーカスを次または前のフォーカス可能な要素に移動します。 | + +無効な Combo はこれらのキーを無視します。 + + + + + +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 + + + +{Platform} Single Selection Combo は、次のロールと属性をレンダリングします。 + +| 要素 | ロール | 属性 | +| --- | --- | --- | +| 入力フィールド | `combobox` | `aria-haspopup="listbox"`、`aria-expanded`、`aria-disabled`、リストを指す `aria-controls`、およびヘルパー テキストがある場合はそれを指す `aria-describedby` | +| `list` パーツ | `listbox` | `aria-multiselectable="false"`、入力フィールドを指す `aria-labelledby`、およびアクティブなオプションを指す `aria-activedescendant` | +| 各 `item` パーツ | `option` | `aria-selected`、`aria-posinset`、`aria-setsize` | +| `clear-icon` パーツ | `button` | リソース文字列からの `aria-label` | + +{Platform} Single Selection Combo は、支援技術に対して次のようにも動作します。 + +- 入力フィールドは、`label` からアクセシブル名を取得します。ラベルがない場合は、オプションが選択されているかどうかを示すリソース文字列から名前を取得します。 +- 入力フィールドは編集可能であり、ユーザーが入力したテキストがリストのフィルターになります。 +- フォーカスがリストにある間、アクティブなオプションは `aria-activedescendant` を通じて読み上げられます。 +- 閉じているドロップダウンのコンテンツは `inert` です。 + + + + + +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` または 入力からアクセシブル名を取得します。これらがない場合は、オプションが選択されているかどうかを示すリソース文字列から名前を取得します。 + + + +### アクセシビリティ コンプライアンス + +Infragistics は、[アクセシビリティ コンプライアンス](../../interactivity/accessibility-compliance.mdx)トピックで、Section 508 と WCAG 2.1 のガイドライン領域に対する {ProductName} のアクセシビリティ サポートを文書化しています。 + +| 基準 | コンポーネントの準拠方法 | +| --- | --- | +| [1.3.1 情報及び関係性](https://www.w3.org/WAI/WCAG21/Understanding/info-and-relationships) | `combobox`、`listbox`、`option` ロールが構造を公開し、リストは`igxLabel` または `ariaLabelledBy` 要素入力フィールドによってラベル付けされます。 | +| [2.1.1 キーボード](https://www.w3.org/WAI/WCAG21/Understanding/keyboard) | 入力でリストがフィルタリングされ、矢印キーでドロップダウンを開いてオプション間を移動でき、Enter キーでアクティブなオプションを選択します。 | +| [2.1.2 キーボード トラップなし](https://www.w3.org/WAI/WCAG21/Understanding/no-keyboard-trap) | Tab キーでドロップダウンが閉じ、フォーカスが Combo の外に移動します。 | +| [4.1.2 名前、役割、値](https://www.w3.org/WAI/WCAG21/Understanding/name-role-value) | 入力フィールドは、`combobox` ロール、ラベルからの名前、および `aria-expanded` による展開状態を公開します。各オプションは、`aria-selected` によって選択状態を公開します。 | + +開発者の責任: + +- すべての Combo に、ユーザーが何を選択するかを示すラベルを付けます。[タイプ](#タイプ)を参照してください。 +- テーマの色をオーバーライドする場合は、[1.4.11 非テキストのコントラスト](https://www.w3.org/WAI/WCAG21/Understanding/non-text-contrast)で要求されているとおり、境界線とフォーカス インジケーターに 3:1 以上のコントラスト比を維持します。 +- エラー メッセージは、色だけでなくヘルパー テキストに表示します。[検証状態](#検証状態)を参照してください。 + +## 既知の制限 + + + +- 単一選択モードではドロップダウンの検索入力が非表示になるため、`placeholderSearch`、`caseSensitiveIcon`、`autofocusList` は効果がありません。 +- {Platform} Combo はカスタム値を追加しません。入力フィールドのテキストがどのオプションにも一致しない場合、Combo はフォーカスを失ったときに入力フィールドをクリアします。 + + + + + +- Angular Simple Combo が `undefined` を含むプリミティブの配列にバインドされている場合、リストには `undefined` が表示されません。オブジェクトの `valueKey` フィールドが `undefined` の場合、リストには項目が表示されますが、ユーザーは選択できません。 +- Angular Simple Combo が `ngModel` にバインドされていて `required` の場合、`null`、`undefined`、`''` の値は選択できません。 +- Angular Simple Combo がリモート サービスにバインドされていて、事前定義された選択がある場合、データが読み込まれるまで入力フィールドは空白のままです。 +- リストは[仮想スクロール](../../layouts/virtual-scroll.mdx#known-limitations)を使用するため、その制限が適用されます。リストは表示範囲内のオプションのみをレンダリングするため、DOM を照会するコードは、それらのオプションのみを検出します。 + + + +## API リファレンス + +{Platform} Single Selection Combo の API リファレンスは、対象プラットフォームの完全な API サーフェスを一覧表示します。 + + + +- + + + + + +- + + + + + +- +- +- +- + + + +## 依存関係 + +{Platform} Single Selection Combo は、色とサイズを適用するためにテーマを必要とします。フレームワーク固有のセットアップについては、[**はじめに**](../../general/getting-started.mdx)[**はじめに**](../../general-getting-started.mdx)を参照してください。 + + + +Angular Simple Combo は、ドロップダウン、入力グループ、アイコン、オーバーレイを使用します。これらのテーマが各パーツのスタイルを設定します。 + +- +- +- +- + + + + + +`IgcComboComponent` の登録では、Combo がレンダリングする入力、アイコン、ポップオーバー要素も登録されます。アイコンなど、Combo のスロットに配置するコンポーネントは別途登録してください。 + + + + + +Blazor Combo と、アイコンなど、そのスロットに配置するコンポーネントは、最初にレンダリングされるときにモジュールを読み込みます。[コンポーネント モジュール](../../general-getting-started.mdx#component-modules)を参照してください。 + + + +## その他のリソース + +{Platform} Single Selection Combo に関するその他のガイダンスとプロジェクト サポートについては、次のリソースを参照してください。 + + + +- [Combo](./overview.mdx) +- [Combo の機能](../../combo-features.mdx) +- [Combo リモート バインディング](../../combo-remote.mdx) +- [Combo テンプレート](./templates.mdx) +- [カスケード Combo を使用したグリッド](../../grid/cascading-combos.mdx) + + + + + +- [Combo](./overview.mdx) +- [Combo の機能](./features.mdx) +- [Combo テンプレート](./templates.mdx) + + + +- [Combo - デザイン システム コンポーネント](https://www.infragistics.com/products/indigo-design/help/components/combo) +- [{ProductName} **フォーラム (英語)**]({ForumsLink}) +- [{ProductName} **GitHub (英語)**]({GithubLink}) + +## 関連コンポーネント + +{Platform} Single Selection Combo は、ユーザーがリストを検索して 1 つのオプションを選択できるようにします。選択の動作が異なる場合は、次のコンポーネントを使用します。 + +- [Combo](./overview.mdx) - ユーザーが複数のオプションを選択する場合に Combo を使用します。 +- [選択](../../select.mdx)[選択](../select.mdx) - 検索が不要な短いリストから、ユーザーが 1 つのオプションを選ぶ場合に選択を使用します。 +- [ドロップダウン](../../drop-down.mdx)[ドロップダウン](../dropdown.mdx) - ボタンやその他の要素からアクションまたはオプションのリストを表示する場合にドロップダウンを使用します。 + +## FAQ + +これらの質問では、{Platform} Single Selection Combo の一般的なセットアップ、選択、使用シナリオを取り上げます。 + + + + Combo の代わりに、Angular Simple Combo (`igx-simple-combo` コンポーネント) を使用します。Simple Combo は 1 つの項目を選択し、ユーザーは入力フィールドに入力してリストをフィルタリングできます。{Platform} Combo で `singleSelect` を設定します。すると Combo は一度に 1 つの項目を選択し、ユーザーは入力フィールドに入力してリストをフィルタリングできます。ドロップダウンの検索入力とチェックボックスは非表示になります。 + + + Angular Simple Combo を `[(ngModel)]` またはフォーム コントロールで 1 つの `valueKey` の値にバインドするか、項目を指定して `select` メソッドを呼び出します。`valueKey` がない場合、Simple Combo は `data` 内のオブジェクトへの参照を使用します。{Platform} Combo の `value` に項目の `valueKey` の値を持つ配列を設定するか、項目を指定して `select` メソッドを呼び出します。`valueKey` がない場合、{Platform} Combo は `data` 内のオブジェクトへの参照を使用します。 + + + はい。Angular Simple Combo で `allowCustomValues` を設定すると、テキストがどのオプションにも一致しない場合にドロップダウンに項目追加ボタンが表示されます。Simple Combo は、そのテキストを新しい項目として追加して選択します。いいえ。{Platform} Combo は `data` のオプションからのみ選択します。入力フィールドのテキストがどのオプションにも一致しない場合、Combo はフォーカスを失ったときに入力フィールドをクリアします。 + + + Angular Simple Combo は `displayKey` フィールドでフィルタリングします。`disableFiltering` が設定されていないこと、および `filteringOptions` または `filterFunction` がリストに表示するフィールドと一致していることを確認してください。{Platform} Combo は、`displayKey` フィールド、または `filteringOptions` の `filterKey` でフィルタリングします。`disableFiltering` が設定されていないこと、およびそのキーがオプションのフィールドを指していることを確認してください。 + + + リストが長く、ユーザーが入力して検索する必要がある場合は、{Platform} Single Selection Combo を使用します。検索せずにオプションを選ぶ短いリストには、{Platform} 選択を使用します。 + + diff --git a/docs/xplat/src/content/jp/components/inputs/combo/templates.mdx b/docs/xplat/src/content/jp/components/inputs/combo/templates.mdx index 23b89164ca..1d89140312 100644 --- a/docs/xplat/src/content/jp/components/inputs/combo/templates.mdx +++ b/docs/xplat/src/content/jp/components/inputs/combo/templates.mdx @@ -1,359 +1,707 @@ --- -title: "{Platform} コンボボックス コンポーネントのテンプレート – {ProductName}" -description: "{ProductName} コンボボックス コンポーネントのテンプレート" -keywords: "{ProductName}, UI コントロール, {Platform} ウィジェット, web ウィジェット, UI ウィジェット, {Platform}, ネイティブ {Platform} コンポーネント スイート, ネイティブ {Platform} コントロール, ネイティブ {Platform} コンポーネント ライブラリ, {Platform} コンボボックス コンポーネントのテンプレート" +title: "{Platform} Combo (コンボ) テンプレート" +description: "{ProductName} Combo (コンボ) テンプレートは、項目、グループ ヘッダー、リストのヘッダーとフッター、空のリスト、トグル アイコンとクリア アイコン、入力フィールドなど、Combo の各領域の既定のコンテンツを置き換えます。" +keywords: "{Platform} Combo テンプレート, {ProductName}, コンボ項目テンプレート, コンボ グループ ヘッダー テンプレート, コンボ ヘッダー テンプレート, コンボ フッター テンプレート, コンボ空のリスト テンプレート, コンボ トグル アイコン, コンボ クリア アイコン, テンプレート化されたコンボ入力" license: MIT -mentionedTypes: ["Combo"] +last_updated: "2026-11-09" +mentionedTypes: ["Combo", "ComboItem", "ComboHeader", "ComboList"] _language: ja llms: - description: "{ProductName} コンボボックス コンポーネントを使用すると、項目、グループ ヘッダー、空のリスト、アイコンなど、さまざまな領域のカスタム テンプレートを定義できます。" + description: "{ProductName} Combo (コンボ) テンプレートは、項目、グループ ヘッダー、リストのヘッダーとフッター、空のリスト、トグル アイコンとクリア アイコン、入力フィールドなど、Combo の各領域の既定のコンテンツを置き換えます。" --- import PlatformBlock from 'igniteui-astro-components/components/mdx/PlatformBlock.astro'; import Sample from 'igniteui-astro-components/components/mdx/Sample.astro'; import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro'; -# {Platform} コンボボックスのテンプレート +# Combo (コンボ) テンプレート -{ProductName} コンボボックス コンポーネントを使用すると、項目、グループ ヘッダー、空のリスト、アイコンなど、さまざまな領域のカスタム テンプレートを定義できます。 +{ProductName} Combo (コンボ) テンプレートは、項目、グループ ヘッダー、リストのヘッダーとフッター、空のリスト、トグル アイコンとクリア アイコン、入力フィールドなど、Combo の各領域の既定のコンテンツを置き換えます。 -## コンボボックス テンプレートの例 + - +Angular の Combo は、各テンプレートを `ng-template` 要素とそのテンプレート ディレクティブの 1 つで受け取り、`igx-combo` 要素内に配置します。[Combo](./overview.mdx#getting-started) トピックに示すように、ディレクティブは `IGX_COMBO_DIRECTIVES` トークンに含まれています。入力フィールドをテンプレート化する `igxLabel`、`igx-prefix`、`igx-suffix`、`igx-hint` 要素も同様です。 -## テンプレート タイプ + + + + +{Platform} の Combo は、 プロパティと プロパティで項目とグループ ヘッダーを描画し、その他の領域のコンテンツはスロットで受け取ります。単純なテキストや記号には `` を、アイコンには [Icon](../../layouts/icon.mdx) を使用します。`header` スロットと `footer` スロットは、`
` 要素と `