Close
Angular React Web Components Blazor Blazor
Open Source

Combo (コンボ) テンプレート

Ignite UI for Blazor Combo のテンプレートは、Combo の各領域 (項目、グループ ヘッダー、リストのヘッダーとフッター、空のリスト、トグル アイコンとクリア アイコン、入力フィールド) の既定のコンテンツを置き換えます。

Blazor の Combo は、ItemTemplateScript パラメーターと GroupHeaderTemplateScript パラメーターが名前で参照する JavaScript テンプレート関数で項目とグループ ヘッダーを描画し、その他の領域のコンテンツはスロットで受け取ります。単純なテキストや記号には <span> を、アイコンには Icon を使用します。header スロットと footer スロットは、<header> 要素と <footer> 要素も受け取ります。

ライブ デモ

このサンプルでは、都市を地域別にグループ化した Destinations Combo を示します。各スイッチは Combo にテンプレートを 1 つずつ適用し、Combo の下の Selection リストには選択された都市が表示されます。

タイプ

Blazor の Combo には、描画する各領域のテンプレートがあります。以下のセクションでは、各テンプレートを受け取るプロパティまたはスロットを示します。

スニペットでは、id、name、country、countryCode、region、UTC の offset を持つ目的地のデータに Combo をバインドします。valueKey は id、displayKey は name、groupKey は region です。Blazor のスニペットでは、同じフィールドをパスカル ケースで使用します: Id、Name、Country、CountryCode、Region、Offset。

Item Template (項目テンプレート)

項目テンプレートは、リスト内の各オプションのコンテンツを描画します。既定では、オプションは displayKey の値を表示し、オプションのチェックボックスはテンプレートのコンテンツの前に残ります。

項目テンプレートとグループ ヘッダー テンプレートは Combo のシャドウ DOM 内に描画されるため、ページのスタイルは適用されません。コンテナーのスタイルは item と group-header の CSS パーツで設定し、コンテンツのレイアウトはインライン スタイルで指定します。Combo はテンプレートの各ルート要素をブロックとしてレイアウトするため、テンプレートのコンテンツは 1 つの要素でラップしてください。

テンプレートは、wwwroot 配下の JavaScript ファイル (たとえば templates.js) に定義します。テンプレートは、項目を受け取り、igTemplating の html タグで作成したテンプレートを返す関数です。igRegisterScript は、この関数を Combo が参照する名前で登録します:

const html = window.igTemplating.html;

const itemTemplate = ({ item }) => html`
    <span>
        <img src="https://dl.infragistics.com/x/img/flags/${item.CountryCode}.png" alt="" style="width: 1.25rem;" />
        ${item.Name} — ${item.Country} · ${item.Id} · ${item.Offset}
    </span>
`;

igRegisterScript("ComboItemTemplate", itemTemplate, false);

このファイルを wwwroot/index.html で読み込みます。このスクリプトはページの読み込み中に igRegisterScript を呼び出すため、app.bundle.js は Blazor スクリプトより前に読み込んでください:

<body>
    <script src="_content/IgniteUI.Blazor/app.bundle.js"></script>
    <script src="_framework/blazor.webassembly.js"></script>
    <script src="templates.js"></script>
</body>

次に、ItemTemplateScript パラメーターにテンプレートの名前を設定します:

<IgbCombo T="string" Data="Destinations" ValueKey="Id" DisplayKey="Name" GroupKey="Region" ItemTemplateScript="ComboItemTemplate" />

Header Item Template (ヘッダー項目テンプレート)

ヘッダー項目テンプレートは、Combo に groupKey が設定されている場合に、各グループのヘッダーを描画します。既定では、グループ ヘッダーにグループの値が表示されます。テンプレートが受け取るのはデータ項目ではなくヘッダー レコードで、その groupKey フィールドにグループの値が入ります。そのため、グループ内のオプション数は、スニペットの citiesIn メソッドのように Combo のデータから取得します。

テンプレートを templates.js に登録し、GroupHeaderTemplateScript パラメーターにその名前を設定します:

const groupHeaderTemplate = ({ item }) => html`
    <span style="display: flex; gap: 0.5rem; width: 100%;">
        <strong>${item.Region}</strong>
        <span style="margin-inline-start: auto;">${citiesIn(item.Region)} cities</span>
    </span>
`;

igRegisterScript("ComboGroupHeaderTemplate", groupHeaderTemplate, false);
<IgbCombo T="string" Data="Destinations" ValueKey="Id" DisplayKey="Name" GroupKey="Region" GroupHeaderTemplateScript="ComboGroupHeaderTemplate" />

Header Template (ヘッダー テンプレート)

ヘッダー テンプレートは、検索入力とオプションのリストの間に、リストのタイトルやリストに適用するアクションなどのコンテンツを描画します。Combo は既定ではヘッダーを描画しません。

コンテンツを header スロットに渡します。このスニペットでは、バインドされた値をすべての目的地の Id の値に設定して、すべてのオプションを選択するボタンを追加します:

<IgbCombo @bind-Value="SelectedDestinations" Data="Destinations" ValueKey="Id" DisplayKey="Name" GroupKey="Region">
    <header slot="header" class="list-header">
        <span>Destinations by region</span>
        <IgbButton Variant="ButtonVariant.Flat" @onclick="SelectAll">Select all</IgbButton>
    </header>
</IgbCombo>

@code {
    private string[] SelectedDestinations { get; set; } = [];

    private void SelectAll() => SelectedDestinations = Destinations.Select(d => d.Id).ToArray();
}

フッター テンプレートは、オプションのリストの下に、選択の概要や選択に適用するアクションなどのコンテンツを描画します。Combo は既定ではフッターを描画しません。

コンテンツを footer スロットに渡します。このスニペットでは、バインドされた値から選択された項目数を表示し、空の配列を設定して選択をクリアします:

<IgbCombo @bind-Value="SelectedDestinations" Data="Destinations" ValueKey="Id" DisplayKey="Name" GroupKey="Region">
    <footer slot="footer" class="list-footer">
        <span>@SelectedDestinations.Length selected</span>
        <IgbButton Variant="ButtonVariant.Flat" @onclick="() => SelectedDestinations = []">Clear</IgbButton>
    </footer>
</IgbCombo>

Empty Template (空のリスト テンプレート)

空のリスト テンプレートは、検索テキストに一致するオプションがない場合、または Combo にデータがない場合に、リストの代わりに描画されます。既定では、Combo はリストが空であることを示すメッセージを表示します。

コンテンツを empty スロットに渡します:

<IgbCombo T="string" Data="Destinations" ValueKey="Id" DisplayKey="Name" GroupKey="Region">
    <span slot="empty" class="empty-list">No city matches your search. Try another spelling.</span>
</IgbCombo>

Toggle Icon Template (トグル アイコン テンプレート)

トグル アイコン テンプレートは、入力フィールド内のトグル ボタン (ドロップダウンを開閉するボタン) のアイコンを置き換えます。

アイコンを toggle-icon スロットに渡します。スロットのコンテンツは、ドロップダウンが閉じているときも開いているときも表示されます。Icon トピックに示すように、最初にアイコンを登録してください:

<IgbCombo T="string" Data="Destinations" ValueKey="Id" DisplayKey="Name">
    <IgbIcon slot="toggle-icon" @ref="IconRef" IconName="flight" Collection="material" />
</IgbCombo>

@code {
    private IgbIcon IconRef { get; set; }

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        if (firstRender && this.IconRef != null)
        {
            await this.IconRef.EnsureReady();
            await this.IconRef.RegisterIconFromTextAsync("flight", FlightIcon, "material");
        }
    }
}

Clear Icon Template (クリア アイコン テンプレート)

クリア アイコン テンプレートは、入力フィールド内のクリア ボタンのアイコンを置き換えます。Combo は、項目が選択されている場合にのみクリア ボタンを表示します。disableClear が設定されている場合は非表示になります。

アイコンを clear-icon スロットに渡します:

<IgbCombo T="string" Data="Destinations" ValueKey="Id" DisplayKey="Name">
    <IgbIcon slot="clear-icon" IconName="close" Collection="material" />
</IgbCombo>

Templated Input (テンプレート化された入力)

Combo の入力フィールドは、Input と同様に、ラベル、テキストの前後のコンテンツ、およびその下のヘルパー テキストを受け取ります。

Label パラメーターを設定し、テキストの前後のコンテンツを prefix スロットと suffix スロットに、ヘルパー テキストを helper-text スロットに渡します。suffix スロットは、クリア アイコンの後、トグル アイコンの前に描画されます:

<IgbCombo @bind-Value="SelectedDestinations" Data="Destinations" ValueKey="Id" DisplayKey="Name" Label="Destinations" Placeholder="Pick one or more cities">
    <IgbIcon slot="prefix" IconName="place" Collection="material" />
    <IgbBadge slot="suffix">@SelectedDestinations.Length</IgbBadge>
    <span slot="helper-text">@SelectedDestinations.Length of @Destinations.Count destinations selected</span>
</IgbCombo>

API リファレンス

Blazor Combo の API リファレンスには、対象プラットフォームの完全な API が記載されています。

その他のリソース

次のリソースでは、Blazor Combo に関するその他のガイダンスとプロジェクトのサポートを提供します: