Web Components Banner (バナー) の概要

Ignite UI for Web Components Banner コンポーネントは、スナックバーより長い時間の表示でダイアログより控えめのメッセージを簡単に表示できます。また、メッセージのコンテキストに基づいて実行するアクションを示すこともできます。

Ignite UI for Web Components Banner の例

使用方法

まず、次のコマンドを実行して Ignite UI for Web Components をインストールする必要があります:

npm install igniteui-webcomponents

次に、以下のように、IgcBannerComponent とそれに必要な CSS をインポートし、そのモジュールを登録する必要があります:

import { defineComponents, IgcBannerComponent } from "igniteui-webcomponents";
import 'igniteui-webcomponents/themes/light/bootstrap.css';

defineComponents(IgcBannerComponent);

Ignite UI for Web Components の完全な概要については、作業の開始トピックを参照してください。

Banner の表示

Banner コンポーネントを表示するには、ボタン クリックで show メソッドを呼び出します。バナーは、要素がページ テンプレートに挿入された場所にその他すべてのコンテンツを移動して表示されます。通常、閉じるためのユーザー操作をほとんど必要としない非侵入型コンテンツを表示します。

<igc-button onclick="banner.show()">Show Banner</igc-button>

<igc-banner id="banner">
    You are currently offline.
</igc-banner>

[!NOTE] IgcBannerComponent には、バナーを閉じるデフォルトの OK アクション ボタンが含まれています。

例

IgcBannerComponent コンポーネントは、マテリアル デザイン バナー ガイドラインにできるかぎり準拠しながらコンテンツをテンプレート化します。

バナー メッセージの変更

igc-banner タグに渡されるコンテンツを変更することによりバナーに表示されるメッセージを設定できます。指定したバナー領域にテキストが表示され、表示時にバナーはデフォルト テンプレートを使用します。以下は、サンプル バナーのコンテンツを変更してより多くの情報を提供します。

<igc-banner id="banner">
    You have lost connection to the internet. This app is offline.
</igc-banner>

アイコンの追加

バナーの prefix スロットを使用して、IgcIconComponent をバナーに表示できます。Icon は常にバナー メッセージの最初に配置されます。

[!NOTE] 複数の IgcIconComponent 要素が挿入される場合、バナーはそれらすべてを最初に配置しようとします。IgcIconComponent は 1 つのみ、直接渡すことに注意してください。

IgcIconComponent をバナーに渡すには、prefix スロットを使用します。

<igc-banner id="banner">
    <igc-icon slot="prefix" name="signal_wifi_off"></igc-icon>
    You have lost connection to the internet. This app is offline.
</igc-banner>

バナー メッセージで IgcIconComponent を使用したい場合は、バナーのコンテンツに挿入するだけです。

<igc-banner id="banner">
    You have lost connection to the internet. This app is offline.
    <igc-icon name="signal_wifi_off"></igc-icon>
</igc-banner>

バナー ボタンの変更

IgcBannerComponent は、バナー ボタンをテンプレート化するための actions スロットを公開します。これにより、デフォルトのバナー ボタン (OK) をオーバーライドし、ユーザー定義のカスタム操作を追加します。

<igc-banner id="banner">
    <igc-icon slot="prefix" name="signal_wifi_off"></igc-icon>
    You have lost connection to the internet. This app is offline.
    <div slot="actions">
        <igc-button onclick="banner.toggle()">
            <igc-ripple></igc-ripple>
            Toggle Banner
        </igc-button>
    </div>
</igc-banner>

イベントにバインド

バナー コンポーネントは、閉じられるときに igcClosing イベントと igcClosed イベントを発行します。igcClosing イベントはキャンセル可能です。CustomEvent インターフェイスを使用し、発行されたオブジェクトの cancelable プロパティは true に設定されています。igcClosing イベントをキャンセルすると、対応する終了アクションとイベントはトリガーされません。バナーは閉じられず、igcClosed イベントも発行されません。

終了イベントをキャンセルするには、preventDefault メソッドを呼び出します。

<igc-banner id="banner">
    ...
</igc-banner>

const banner = document.getElementById('banner') as IgcBannerComponent;

banner.addEventListener('igcClosing', (event) => {
  event.preventDefault();
});

[!NOTE] 上記が適用されると、終了イベントが常にキャンセルされるため、バナーが閉じることはありません。

高度な例

2 つのカスタムボタンのバナーを作成しましょう。1 つは通知を閉じるためのボタンで、もう 1 つは接続をオンにするためのボタンです。actions スロットを使用してカスタム アクション ハンドラーを渡すことができます。

<igc-banner id="banner">
    <igc-icon slot="prefix" name="signal_wifi_off"></igc-icon>
    You have lost connection to the internet. This app is offline.
    <div slot="actions">
        <igc-button onclick="banner.hide()">
            <igc-ripple></igc-ripple>
            Continue Offline
        </igc-button>
        <igc-button id="button">
            <igc-ripple></igc-ripple>
            Turn On Wifi
        </igc-button>
    </div>
</igc-banner>

Google のマテリアル デザイン ガイドラインでは、バナーはに表示するボタンは 2 つまでです。IgcBannerComponent は、actions スロットの要素数を明示的に制限しませんが、マテリアル デザイン ガイドに従う場合は、最大 2 つの要素を使用することを強くお勧めします。

閉じるオプション ('Continue Offline') は詳細なロジックを必要としないため、hide のみの呼び出しが可能です。しかし、確認アクション ('Turn On Wifi') は追加のロジックを必要とするため、コンポーネントで定義する必要があります。次に、click イベントのイベント リスナーを追加します。最後に、変更するたびに refreshBanner() メソッドを呼び出します。これにより、wifiState に基づいてバナーを切り替えます。

ナビゲーション バーには Wi-Fi アイコンが表示され、その click イベントのイベント リスナーも追加されます。変更ごとに refreshBanner() メソッドが呼び出されるため、アイコンはバナーを切り替えるだけでなく、接続の状態に応じて変化します。

<igc-navbar>
  <h1>Gallery</h1>
  <igc-icon id="icon" slot="end" name="signal_wifi_off"></igc-icon>
</igc-navbar>

<igc-banner id="banner">
    ...
    <div slot="actions">
        ...
        <igc-button id="button">
            <igc-ripple></igc-ripple>
            Turn On Wifi
        </igc-button>
    </div>
</igc-banner>

private banner: IgcBannerComponent;
private icon: IgcIconComponent;
private button: IgcButtonComponent;

private wifiState: boolean = false;

constructor() {
    this.banner = document.getElementById('banner') as IgcBannerComponent;
    this.icon = document.getElementById('icon') as IgcIconComponent;
    this.button = document.getElementById('button') as IgcButtonComponent;

    this.icon.addEventListener('click', () => this.refreshBanner());
    this.button.addEventListener('click', () => this.refreshBanner());
}

public refreshBanner() {
    if (!this.wifiState) {
        this.icon.name = 'signal_wifi_4_bar';
        this.banner.hide();
    } else {
        this.icon.name = 'signal_wifi_off';
        this.banner.show();
    }
    this.wifiState = !this.wifiState;
}

最後に、WiFi の状態に関するメッセージを表示する IgcToastComponent を追加します。以下はテンプレート化したバナーのデモです。

スタイル設定

Banner コンポーネントは、いくつかの CSS パーツ (base、spacer、message、illustration、content および actions) を公開して、そのスタイルを完全に制御できるようにします。

igc-banner::part(spacer) {
    background: #dedede;
}

igc-banner::part(illustration) {
    color: #666666;
}

igc-banner::part(content) {
    color: #151515;
}

API リファレンス

• IgcBannerComponent
• IgcCardComponent
• IgcIconComponent
• IgcNavbarComponent
• IgcToastComponent
• IgcRippleComponent

その他のリソース

• Ignite UI for Web Components フォーラム (英語)
• Ignite UI for Web Components GitHub (英語)