From 102a2a192050bfcf2a52c64991cf1c7e1448de6a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 16 Nov 2026 16:54:38 +0000 Subject: [PATCH] docs(jp): sync combo features topic and TOC Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../jp/components/inputs/combo/features.mdx | 735 +++++++++++++----- docs/xplat/src/content/jp/toc.json | 1 + 2 files changed, 522 insertions(+), 214 deletions(-) diff --git a/docs/xplat/src/content/jp/components/inputs/combo/features.mdx b/docs/xplat/src/content/jp/components/inputs/combo/features.mdx index b24e4e5955..5d316d36f2 100644 --- a/docs/xplat/src/content/jp/components/inputs/combo/features.mdx +++ b/docs/xplat/src/content/jp/components/inputs/combo/features.mdx @@ -1,12 +1,14 @@ --- -title: "{Platform} コンボボックス コンポーネント – {ProductName}" -description: "{ProductName} コンボボックス コンポーネントの機能" -keywords: "{ProductName}, UI コントロール, {Platform} ウィジェット, web ウィジェット, UI ウィジェット, {Platform}, ネイティブ {Platform} コンポーネント スイート, ネイティブ {Platform} コントロール, ネイティブ {Platform} コンポーネント ライブラリ, {Platform} コンボボックス コンポーネントの機能" +title: "{Platform} Combo の機能" +description: "{Platform} Combo は、ローカル データへのバインド、入力に応じたオプションのフィルタリング、データ フィールドによるグループ化に対応し、無効にすることもできます。" +keywords: "{ProductName}, UI コントロール, {Platform} ウィジェット, web ウィジェット, UI ウィジェット, {Platform}, ネイティブ {Platform} コンポーネント スイート, ネイティブ {Platform} コントロール, ネイティブ {Platform} コンポーネント ライブラリ, {Platform} Combo の機能, {Platform} Combo データ バインディング, {Platform} Combo フィルタリング, {Platform} Combo グループ化" license: MIT -mentionedTypes: ["Combo", "ComboList", "ComboItem"] +last_updated: "2026-11-16" +platformType: web-only +mentionedTypes: ["Combo"] _language: ja llms: - description: "{ProductName} コンボボックス コンポーネントは、フィルタリングやグループ化などのいくつかの機能を公開しています。" + description: "{Platform} Combo は、ローカル データへのバインド、入力に応じたオプションのフィルタリング、データ フィールドによるグループ化に対応し、無効にすることもできます。" --- import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'; import PlatformBlock from 'igniteui-astro-components/components/mdx/PlatformBlock.astro'; @@ -14,241 +16,368 @@ import Sample from 'igniteui-astro-components/components/mdx/Sample.astro'; import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro'; +# Combo (コンボ) コンポーネントの機能 -# {Platform} コンボボックスの機能 - -{ProductName} コンボボックス コンポーネントは、フィルタリングやグループ化などのいくつかの機能を公開しています。 - -## コンボボックス機能の例 -以下のデモは、ランタイムで有効または無効にできるいくつかの 機能を示しています。 - - +{Platform} Combo は、ローカル データへのバインド、入力に応じたオプションのフィルタリング、データ フィールドによるグループ化に対応し、無効にすることもできます。 + +Combo は、リモート サービスからデータをチャンク単位で読み込んだり、カスタム値を受け入れたり、カスタムのオーバーレイ設定でリストを表示したりすることもできます。 + - + -このサンプルでは、 コンポーネントを使用するため、コンボと一緒にインポートする必要があります。 +Combo は、リモート サービスからオプションを 1 ページずつ読み込むこともできます。 +## ライブ デモ - + + -```ts -import { defineComponents, IgcComboComponent, IgcSwitchComponent } from 'igniteui-webcomponents'; -import 'igniteui-webcomponents/themes/light/bootstrap.css'; + -defineComponents(IgcComboComponent, IgcSwitchComponent); -``` + + + +## 機能 +### データ バインディング - +次のスニペットは、{Platform} Combo の プロパティで米国の州のローカル リストにバインドし、各州のコードを保持して名前を表示します。Combo が各項目から読み取るキーについては、Combo の概要トピックの[データ バインディング](./overview.mdx#data-binding)を参照してください。 -このサンプルでは コンポーネントを使用します。 + -{ProductName} のサービスを登録します。 +```typescript +import { usStates } from './states-data'; -```csharp -// in Program.cs file +export class ComboDataBindingComponent { + // Items such as { id: 'CT', name: 'Connecticut', region: 'New England' } + public usStates = usStates; +} +``` -builder.Services.AddIgniteUIBlazor(); +```html + ``` -Combo のクライアント リソース モジュールである の登録は**任意**です。コンポーネントは初めてレンダリングされるときにリソースを読み込みます。ただし、`builder.Services.AddIgniteUIBlazor(typeof(IgbComboModule))` のように指定すると、リソースを事前に読み込んだり、クライアント側でのみ作成される要素に対応したりできます ([コンポーネント モジュール](../../general-getting-started.mdx#コンポーネント-モジュール)を参照)。 + -また、追加の CSS ファイルをリンクして、スタイルを コンポーネントに適用する必要があります。以下は、アプリのホスト ページ (スタンドアロンの Blazor WebAssembly アプリまたは Blazor Hybrid アプリでは **wwwroot/index.html**、Blazor Server アプリでは **Pages/_Host.cshtml**、Blazor Web App では **Components/App.razor**) に配置する必要があります: + -```razor - +```html + ``` +```ts +import { IgcComboComponent } from 'igniteui-webcomponents'; +import { UsState, usStates } from './ComboData'; + +// Items such as { id: 'CT', name: 'Connecticut', region: 'New England' } +const combo = document.getElementById('combo') as IgcComboComponent; +combo.data = usStates; +``` + +```razor + - +@code { + // Items such as new UsState { Id = "CT", Name = "Connecticut", Region = "New England" } + private List usStates = UsStatesData.States; + private string[] selectedStates = []; +} +``` + +`IgbCombo` は、`Data` と `@bind-Value` から値の型を推論します。このトピックの以降の Blazor スニペットではこれらを省略しているため、スニペットをコピーするときは追加してください。 + + ```tsx -import { IgrCombo, IgrSwitch } from 'igniteui-react'; -import 'igniteui-webcomponents/themes/light/bootstrap.css'; -``` +import { IgrCombo } from "igniteui-react"; +import { usStates } from "./ComboData"; +// Items such as { id: "CT", name: "Connecticut", region: "New England" } + +``` + -次に、React の useState フックを使用して、スイッチの状態変化に応じて更新される変数を定義します。これにより、状態が追跡され、コンボボックスの入力に反映されます。 +### リモート バインディング - +Combo は、リモート サービスからデータをチャンク単位で読み込めます。ユーザーがスクロールした位置の項目を イベントで要求し、サービスはそれらの項目のみを返します。次のサンプルは、ユーザーのスクロールや検索に合わせて、リモート サービスから製品を読み込みます。 -```tsx -const [disableFiltering, setDisableFiltering] = useState(false); -const [caseSensitiveIcon, setCaseSensitiveIcon] = useState(false); -const [groupingEnabled, setGroupingEnabled] = useState(false); -const [comboDisabled, setComboDisabled] = useState(false); - - - - - - setDisableFiltering(e.detail.checked)}> - Disable Filtering - - setCaseSensitiveIcon(e.detail.checked)}> - Show Case-sensitive Icon - - setGroupingEnabled(e.detail.checked)}> - Enable Grouping - - setComboDisabled(e.detail.checked)}> - Disable Combo - -``` + - +#### リモート サービスの定義 - +リモート サービスは、サーバーから項目をオンデマンドで読み込みます。Combo は プロパティを公開しており、読み込む最初の項目のインデックスと読み込む項目数を保持します。サーバー上のすべての項目に合わせてスクロール バーのサイズを設定するには、 プロパティに項目の合計数を設定します。 -```ts -let combo = document.getElementById('combo') as IgcComboComponent; +次のサービスには、Combo の状態と検索テキストからリクエストを作成し、読み込んだ項目を Observable で発行する `getData()` メソッドがあります。 -let switchIcon = document.getElementById('caseSensitive') as IgcSwitchComponent; -let switchFilter = document.getElementById('filtering') as IgcSwitchComponent; -let switchDisable = document.getElementById('disabled') as IgcSwitchComponent; +```typescript +import { HttpClient } from '@angular/common/http'; +import { Injectable, inject } from '@angular/core'; +import { IForOfState } from 'igniteui-angular/directives'; +// import { IForOfState } from '@infragistics/igniteui-angular/directives'; for licensed package +import { BehaviorSubject } from 'rxjs'; -switchIcon.addEventListener("igcChange", () => { - combo.caseSensitiveIcon = switchIcon.checked; -}); +@Injectable() +export class RemoteNWindService { + private http = inject(HttpClient); + private url = 'https://services.odata.org/V4/Northwind/Northwind.svc/Products'; -switchFilter.addEventListener("igcChange", () => { - combo.disableFiltering = switchIcon.disabled = switchFilter.checked; -}); + public remoteData = new BehaviorSubject([]); -switchDisable.addEventListener("igcChange", () => { - combo.disabled = switchDisable.checked; -}); + public getData(state: IForOfState, searchText: string, cb?: (data: any) => void) { + return this.http.get(this.buildUrl(state, searchText)).subscribe((data: any) => { + this.remoteData.next(data.value); + cb?.(data); + }); + } + + // Requests the chunk of items the Combo shows, and the total count of the matching items. + private buildUrl(state: IForOfState, searchText: string): string { + let query = `?$skip=${state.startIndex}&$top=${state.chunkSize}&$count=true`; + if (searchText) { + // Double the apostrophes for OData, then encode the text for the URL. + const text = encodeURIComponent(searchText.replace(/'/g, "''")); + query += `&$filter=contains(ProductName, '${text}')`; + } + return `${this.url}${query}`; + } +} ``` - +#### ComboBox をリモート サービスにバインド - +サービスの Observable を `async` パイプで Combo にバインドし、Combo が を発生させたとき、または検索テキストが変更されたときに、新しい項目のチャンクを要求します。 -```razor - - - -Disable Filtering -Show Case-sensitive Icon -Enable Grouping -Disable Combo - -@code { - private string[] SelectedCities = []; - private bool DisableFiltering = false; - private bool CaseSensitiveIcon = false; - private bool Disabled = false; +```html + + + +``` + +```typescript +// The size of the first chunk, requested before the Combo reports how many items it shows. +const FIRST_CHUNK_SIZE = 10; + +// The component lists RemoteNWindService in its providers, and the application +// providers include provideHttpClient(), which the service needs. +export class ComboRemoteComponent implements OnInit { + @ViewChild('remoteCombo', { static: true }) + public remoteCombo: IgxComboComponent; + + private remoteService = inject(RemoteNWindService); + public rData = this.remoteService.remoteData; + private searchText = ''; + + public ngOnInit() { + this.loadChunk({ startIndex: 0, chunkSize: FIRST_CHUNK_SIZE }); + } - public void OnDisableFilteringClick(IgbCheckboxChangeEventArgs e) { - this.DisableFiltering = e.Detail.Checked; + // The Combo asks for the next chunk while the user scrolls. + public onDataPreLoad() { + this.loadChunk(this.remoteCombo.virtualizationState); } - public void OnCaseSensitiveClick(IgbCheckboxChangeEventArgs e) { - this.CaseSensitiveIcon = e.Detail.Checked; + // The server filters the items: request the first chunk of the matching ones. + public onSearchInputUpdate(event: IComboSearchInputEventArgs) { + this.searchText = event.searchText; + this.loadChunk({ startIndex: 0, chunkSize: FIRST_CHUNK_SIZE }); } - public void OnDisableClick(IgbCheckboxChangeEventArgs e) { - this.Disabled = e.Detail.Checked; + private loadChunk(state: IForOfState) { + this.remoteService.getData(state, this.searchText, (data) => { + // The total count sizes the scrollbar for all the items, not only the loaded chunk. + this.remoteCombo.totalItemCount = data['@odata.count']; + }); } } ``` +#### 選択の処理 + +Combo がチャンク単位で読み込むリモート データにバインドされ、データ項目がオブジェクトである場合は、 プロパティを設定します。設定しないと、Combo は選択された項目と読み込まれた項目を参照で比較します。これについては [Combo トピック](./overview.mdx#data-binding)で説明しています。サービスがチャンクを読み込むたびに新しいオブジェクトが作成されるため、Combo は選択された項目をそれらと照合できません。 + + +Combo をリモート データにバインドするときは、`valueKey` プロパティに各項目で一意のプロパティを設定します。 + + -グループ化は、 プロパティを対応するデータ ソース フィールドに設定することで有効/無効になることに注意してください。 + + +### リモート バインディング + +{Platform} Combo は、リモート サービスからオプションを 1 ページずつ読み込めます。検索とページングはサービスがサーバー上で行い、Combo はまだ読み込まれていない各項目のプレースホルダーを表示します。次のサンプルは、ユーザーのスクロールや検索に合わせて、リモート サービスから製品を読み込みます。 + + + + -```ts -let switchGroup = document.getElementById('grouping') as IgcSwitchComponent; + +リモート バインディングには `igniteui-webcomponents` 7.5.0 以降が必要です。 + -switchGroup.addEventListener("igcChange", () => { - this.combo.groupKey = switchGroup.checked ? "country" : undefined; -}); -``` + + + + + +リモート バインディングには、`igniteui-webcomponents` 7.5.0 以降に依存するバージョンの `igniteui-react` が必要です。 + - + -```razor -@code { - private string Group = ""; +#### Combo をリモート サービスにバインド - public void OnGroupClick(IgbCheckboxChangeEventArgs e) { - this.Group = e.Detail.Checked ? "Country" : ""; - } +`igniteui-webcomponents/extras/combo-data-source` から `bindComboDataSource()` をインポートし、Combo と `load()` 関数を持つソースを渡します。バインディングは、`searchText`、`caseSensitive`、`startIndex`、`count` を保持するリクエストと `AbortSignal` を指定して、ページごとに `load()` を呼び出します。そのページの項目と、一致する項目の合計数を返します。 + + + + + +```html + +``` + +```ts +import { defineComponents, IgcComboComponent } from 'igniteui-webcomponents'; +import { bindComboDataSource } from 'igniteui-webcomponents/extras/combo-data-source'; + +defineComponents(IgcComboComponent); + +interface Product { + ProductID: number; + ProductName: string; } + +const url = 'https://services.odata.org/V4/Northwind/Northwind.svc/Products'; +const combo = document.getElementById('combo') as IgcComboComponent; + +const binding = bindComboDataSource(combo, { + // Loads one page of the products that match the search text. + load: async ({ searchText, startIndex, count }, signal) => { + let query = `?$skip=${startIndex}&$top=${count}&$count=true`; + if (searchText) { + // Double the apostrophes for OData, then encode the text for the URL. + const text = encodeURIComponent(searchText.replace(/'/g, "''")); + query += `&$filter=contains(ProductName, '${text}')`; + } + + // The signal lets a newer search abort this request. + const response = await fetch(`${url}${query}`, { signal }); + const data = await response.json(); + return { items: data.value, totalCount: data['@odata.count'] }; + } +}, { + // The service returns up to 20 products per request. + pageSize: 20 +}); ``` +React では、`IgrCombo` の `ref` が保持する要素を渡し、コンポーネントのアンマウント時にバインディングを破棄します。 + ```tsx -groupKey={groupingEnabled ? "country" : undefined} +import { useEffect, useRef } from "react"; +import { IgrCombo } from "igniteui-react"; +import { bindComboDataSource } from "igniteui-webcomponents/extras/combo-data-source"; + +const url = "https://services.odata.org/V4/Northwind/Northwind.svc/Products"; + +export default function RemoteCombo() { + const comboRef = useRef(null); + + useEffect(() => { + const binding = bindComboDataSource(comboRef.current!, { + // Loads one page of the products that match the search text. + load: async ({ searchText, startIndex, count }, signal) => { + let query = `?$skip=${startIndex}&$top=${count}&$count=true`; + if (searchText) { + // Double the apostrophes for OData, then encode the text for the URL. + const text = encodeURIComponent(searchText.replace(/'/g, "''")); + query += `&$filter=contains(ProductName, '${text}')`; + } + + // The signal lets a newer search abort this request. + const response = await fetch(`${url}${query}`, { signal }); + const data = await response.json(); + return { items: data.value, totalCount: data["@odata.count"] }; + } + }, { + // The service returns up to 20 products per request. + pageSize: 20 + }); + + return () => binding.dispose(); + }, []); + + return ; +} ``` -## 機能 + -### フィルタリング +バインディングは Combo をリモート フィルタリングに切り替え、次のようにリクエストを行います。 -コンボボックスのフィルタリングがデフォルトで有効になります。無効にするには、 プロパティを設定します。 +- 項目のないリストをユーザーが開いたとき、およびユーザーが検索入力での入力を止めた後に、最初のページを読み込みます。 +- ユーザーが読み込み済みの項目の末尾付近までスクロールすると、次のページを追加します。 +- `load()` が `fetch()` に渡すシグナルによって、新しい検索で古くなったリクエストを中止します。 +- Combo の `totalItemCount` プロパティに合計数を設定し、検索の待機中またはページの読み込み中は `loading` プロパティを設定します。 -フィルタリング オプションは、検索の大文字と小文字の区別を有効にすることでさらに拡張できます。 プロパティを使用して大文字と小文字を区別するアイコンをオンにすると、エンド ユーザーは大文字と小文字の区別を制御できます。 +Combo が保持する項目数が `totalItemCount` より少ない間、リストは読み込む各項目のプレースホルダーを表示するため、スクロール バーには結果の全長が反映されます。`loading` が設定されている間、Combo はトグル アイコンの代わりにスピナーを表示します。スピナーは `loading` スロットで置き換え、スピナーとプレースホルダーのスタイルは `loading` および `placeholder` CSS パーツで設定します。 - +`bindComboDataSource()` の 3 番目の引数でバインディングを構成します。 -```html - -``` +| オプション | 既定値 | 説明 | +|---|---|---| +| `pageSize` | `50` | 1 回のリクエストで読み込む項目の最小数。ソースは、たとえばサーバーのページ上限までの、これより少ない項目を返すことができ、その場合 Combo は残りを要求します。 | +| `debounce` | `300` | 検索を読み込むまでの、入力の待機時間 (ミリ秒)。 | +| `loadOnOpen` | `true` | 項目のないリストをユーザーが開いたときに最初のページを読み込むかどうか。 | +| `onError` | - | 失敗したリクエストのエラーを受け取ります。Combo は項目を保持します。 | + +`bindComboDataSource()` は、2 つのメソッドを持つバインディングを返します。`refresh()` は現在の検索の最初のページを再度読み込みます。コードで `filteringOptions.caseSensitive` を変更した後に呼び出してください。`dispose()` はリスナーを削除し、進行中のリクエストを中止して、Combo のフィルタリング モードを元に戻します。 + +#### リモート フィルタリング モード + +`bindComboDataSource()` は Combo のパブリック API のみを使用します。リクエストを自分で行うには、 の `mode` に `remote` を設定します。 - + -```razor - +```ts +combo.filteringOptions = { mode: 'remote' }; ``` @@ -256,57 +385,92 @@ groupKey={groupingEnabled ? "country" : undefined} ```tsx - +// In an effect, once the Combo has rendered. +comboRef.current!.filteringOptions = { mode: "remote" }; ``` -#### フィルタリング オプション + -{ProductName} は、`FilterKey` オプションと `CaseSensitive` オプションの両方の構成を渡すことができるフィルター プロパティをもう 1 つ公開しています。`FilterKey` は、オプションのリストをフィルタリングするためにどのデータ ソース フィールドを使用する必要があるかを示します。`CaseSensitive` オプションは、フィルタリングで大文字と小文字を区別するかどうかを示します。 +リモート モードでは、Combo は検索をサービスに任せます。 -次のコード スニペットは、名前ではなく国でデータ ソースから都市をフィルター処理する方法を示しています。また、デフォルトで大文字と小文字を区別するフィルタリングを行います。 +- Combo はオプションをフィルタリングしなくなります。`igcSearchInput` イベントの `detail.searchText` を読み取り、サーバーで検索して、 に結果の最初のページを設定します。一致の判定はサーバーが行うため、検索と一緒に `filteringOptions.caseSensitive` を送信してください。 +- ユーザーが `data` の末尾付近までスクロールすると、`igcDataRequest` イベントが `detail.startIndex` から `detail.count` 件の追加項目を要求します。それらを `data` に追加します。 +- `totalItemCount` に結果の合計数を設定し、リクエストの実行中は `loading` を設定します。 +#### 選択の処理 - +Combo がリモート データを読み込む場合は、 を設定します。ページごとに新しいオブジェクトが作成され、Combo はそのキーの値で選択された項目をそれらと照合します。新しい `data` を設定しても選択は保持されます。検索結果に選択された項目が含まれない場合も選択されたままとなり、後のページや検索に含まれると再び選択済みとして表示されます。 +保存済みフィルターの値など、どのページにもまだ項目が読み込まれていない値を選択するには、`bindComboDataSource()` のソースに `resolve()` 関数を追加します。バインディングはそれらの値を指定して `resolve()` を呼び出し、返された項目を選択します。 -```ts -const options = { - filterKey: 'country', - caseSensitive: true -}; +Combo は、選択された項目をサーバーが削除したのか、そのページをまだ送信していないだけなのかを判別できません。ライブ データを再び読み込むときは、サーバーに存在しなくなった選択済み項目に対して を呼び出してください。 + + + + -combo.filteringOptions = options; +### カスタム オーバーレイ設定 + +Combo は項目のリストをオーバーレイに表示します。オーバーレイは、 を 入力に渡して構成できます。Combo はこれらの設定を既定値にマージするため、変更したい設定のみを指定します。次の設定は、リストをモーダルにして背後のページを暗くし、外側をクリックすると閉じます。 + +```typescript +import { OverlaySettings } from 'igniteui-angular/core'; +// import { OverlaySettings } from '@infragistics/igniteui-angular/core'; for licensed package + +export class ComboOverlayComponent { + public overlaySettings: OverlaySettings = { + modal: true, + closeOnOutsideClick: true + }; +} ``` +```html + +``` + + + + +既定では、Combo は でリストを配置します。リストは入力の下に開き、十分なスペースがない場合は上に開きます。 + + +### フィルタリング +{Platform} Combo は、ユーザーがドロップダウンの検索入力に入力すると、オプションのリストをフィルタリングします。フィルタリングは既定で有効です。 を設定するとフィルタリングが無効になり、検索入力も非表示になります。 - + +ユーザーが検索の大文字と小文字の区別を切り替えられるようにするには、 を設定します。すると Combo は、検索入力に大文字と小文字を区別するアイコンを表示します。フィルタリングが無効な間は検索入力が非表示のため、このアイコンは効果がありません。 -```tsx -const options = { - filterKey: 'country', - caseSensitive: true -}; +```html + + - + + ``` + -### グループ化 +ユーザーが検索の大文字と小文字の区別を切り替えられるようにするには、 を設定します。すると Combo は、検索入力に大文字と小文字を区別するアイコンを表示します。フィルタリングが無効な間は検索入力が非表示のため、このアイコンは効果がありません。 - オプションを定義すると、キーに基づいて項目をグループ化します。 + ```html - + + + + + ``` @@ -314,7 +478,11 @@ const options = { ```razor - +@* Shows the case-sensitive icon in the search input *@ + + +@* Turns filtering off, which also hides the search input *@ + ``` @@ -322,23 +490,69 @@ const options = { ```tsx - +// Shows the case-sensitive icon in the search input + + +// Turns filtering off, which also hides the search input + ``` - - プロパティは、データ ソースが複雑なオブジェクトで構成されている場合にのみ有効です。 - +#### フィルタリング オプション -#### ソートの方向 + プロパティは、{Platform} Combo が検索テキストを照合する方法を構成します。 -コンボボックス コンポーネントは、グループを昇順または降順でソートするかどうかを設定するオプションも公開します。デフォルトでは、ソート順序は、昇順に設定されています。 + - +- `filteringKey` - 検索対象のデータ フィールド。既定値は `displayKey` で設定されたフィールドです。 +- `caseSensitive` - 検索で大文字と小文字を区別するかどうか。既定値は `false` です。大文字と小文字を区別するアイコンがこの値を切り替えます。 + + + + + +- `filterKey` - 検索対象のデータ フィールド。既定値は `displayKey` で設定されたフィールドです。 +- `caseSensitive` - 検索で大文字と小文字を区別するかどうか。既定値は `false` です。大文字と小文字を区別するアイコンがこの値を切り替えます。 +- `matchDiacritics` - アクセント付き文字を自身にのみ一致させるかどうか。`true` の場合、`é` は `e` に一致しません。既定値は `false` です。 + + + + + +Blazor では、これらのオプションを `IgbFilteringOptions` オブジェクトで `FilterKey`、`CaseSensitive`、`MatchDiacritics` として設定します。 + + + +次のスニペットは、各州の名前の代わりに地域を検索し、検索で大文字と小文字を区別します。 + + + +```typescript +import { IComboFilteringOptions } from 'igniteui-angular/combo'; +// import { IComboFilteringOptions } from '@infragistics/igniteui-angular/combo'; for licensed package + +export class ComboDemo { + public filteringOptions: IComboFilteringOptions = { + filteringKey: 'region', + caseSensitive: true + }; +} +``` ```html - + +``` + + + + + +```ts +combo.filteringOptions = { + filterKey: 'region', + caseSensitive: true +}; ``` @@ -346,7 +560,15 @@ const options = { ```razor - + + +@code { + private IgbFilteringOptions filteringOptions = new IgbFilteringOptions + { + FilterKey = "Region", + CaseSensitive = true + }; +} ``` @@ -354,47 +576,47 @@ const options = { ```tsx - + ``` -### ラベル + - ラベルは、 プロパティを使用して簡単に設定できます。 +### カスタム値 - + プロパティを使用すると、データに存在しない項目をユーザーが追加できます。検索テキストに一致する項目がない場合、ドロップダウンに **Add item** ボタンが表示され、検索テキストが新しい項目としてデータに追加されます。 ```html - + ``` - +### 検索入力のフォーカス -```razor - -``` +{Platform} Combo のドロップダウンが開くと、検索入力にフォーカスが移ります。 - + - + プロパティを `false` に設定すると、代わりに項目のリストにフォーカスが移ります。モバイル デバイスでは、ドロップダウンと同時にソフトウェア キーボードが開くのを防げます。 -```tsx - +```html + ``` -### プレースホルダー + + + を設定すると、代わりにオプションのリストにフォーカスが移ります。モバイル デバイスでは、ドロップダウンと同時にソフトウェア キーボードが開くのを防げます。 -コンボボックス コンポーネント入力とドロップダウン メニュー内に配置された検索入力の両方に、プレースホルダー テキストを指定できます。 + ```html - + ``` @@ -402,7 +624,7 @@ const options = { ```razor - + ``` @@ -410,27 +632,37 @@ const options = { ```tsx - + ``` -### オートフォーカス +### グループ化 -コンボボックスをページの読み込みに自動的にフォーカスさせたい場合は、次のコードを使用できます。 + にデータ項目のフィールドを設定すると、{Platform} Combo のオプションがそのフィールドの値ごとにヘッダーの下にグループ化されます。 + + + +```html + +``` + + ```html - + ``` +Blazor では、キーは `Region` などの C# プロパティの名前です。 + ```razor - + ``` @@ -438,27 +670,56 @@ const options = { ```tsx - + ``` -### 検索入力のフォーカス + + プロパティは、データ項目がオブジェクトの場合にのみ有効です。 + -コンボボックスの検索入力はデフォルトでフォーカスされています。この機能を無効にしてフォーカスをオプションのリストに移動するには、以下に示すように プロパティを使用します。 +#### 並べ替え方向 + + + + プロパティは、Combo 内のグループの順序を設定します。`SortingDirection.Asc` (既定) は昇順、`SortingDirection.Desc` は降順に並べ替え、`SortingDirection.None` はデータ内で最初の項目が現れる順序を維持します。各グループ内の項目は、データ内の順序のままです。 + +```typescript +import { SortingDirection } from 'igniteui-angular/core'; +// import { SortingDirection } from '@infragistics/igniteui-angular/core'; for licensed package + +export class ComboDemo { + public groupSortingDirection = SortingDirection.Desc; +} +``` + +```html + +``` + + + + + + プロパティは、{Platform} Combo 内のグループの順序を設定します。`asc` (既定) は昇順、`desc` は降順に並べ替え、`none` はデータ内で最初の項目が現れる順序を維持します。各グループ内の項目は、データ内の順序のままです。 + + ```html - + ``` +Blazor では、`GroupingDirection` 値の `Asc`、`Desc`、`None` のいずれかを設定します。 + ```razor - + ``` @@ -466,19 +727,23 @@ const options = { ```tsx - + ``` -### 必須 + + +### クリア ボタン + +{Platform} Combo は、少なくとも 1 つのオプションが選択されている間、入力内にクリア ボタンを表示し、このボタンをクリックすると選択がクリアされます。ボタンを非表示にするには、 を設定します。 -required プロパティを設定することで、コンボボックスを必須としてマークできます。 + ```html - + ``` @@ -486,7 +751,7 @@ required プロパティを設定することで、コンボボックスを必 ```razor - + ``` @@ -494,19 +759,23 @@ required プロパティを設定することで、コンボボックスを必 ```tsx - + ``` -### コンボボックスを無効にする + + +### オートフォーカス + + を設定すると、ページの読み込み時に {Platform} Combo にフォーカスが移ります。 - プロパティを使用してコンボボックスを無効にできます。 + ```html - + ``` @@ -514,26 +783,64 @@ required プロパティを設定することで、コンボボックスを必 ```razor - + ``` +React では、`autoFocus` prop を使用します。 + ```tsx - + ``` + + +### スクロール ストラテジ + + プロパティは、ドロップダウンが開いている間に Combo を囲むコンテナーがスクロールしたとき、{Platform} Combo のドロップダウンの動作を設定します。`hide` (既定) は入力が表示範囲外にある間ドロップダウンを非表示にし、`scroll` はドロップダウンを開いたまま入力に追従させ、`close` はドロップダウンを閉じます。 + + + + + +```html + +``` + + + + + +```tsx + +``` + + ## API リファレンス +{Platform} Combo の完全な API リファレンスを参照してください。 + +- + + -
+- +- + +
## その他のリソース +Combo の詳細については、次の {Platform} リソースを参照してください。 + +- [Combo の概要](./overview.mdx) +- [Combo のテンプレート](./templates.mdx) +- [単一選択の Combo](./single-selection.mdx) - [{ProductName} **フォーラム (英語)**]({ForumsLink}) - [{ProductName} **GitHub (英語)**]({GithubLink}) diff --git a/docs/xplat/src/content/jp/toc.json b/docs/xplat/src/content/jp/toc.json index bc22ac56cd..e08e086f8f 100644 --- a/docs/xplat/src/content/jp/toc.json +++ b/docs/xplat/src/content/jp/toc.json @@ -3405,6 +3405,7 @@ { "name": "機能", "href": "inputs/combo/features.mdx", + "updated": true, "include": [ "Web" ]