この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

lightning:notificationsLibrary

lightning:notificationsLibrary は、アプリケーションでメッセージを簡単に表示できるようにします。このコンポーネントでは、API バージョン 41.0 以降が必要です。このコンポーネントは、Lightning Experience、Salesforce1、および Lightning コミュニティでのみサポートされています。

メッセージを通知およびトーストで表示できます。通知は、ユーザにシステム関連の問題と更新をアラートで伝えます。トーストでは、ユーザがアクションを実行した後に、フィードバックを提供でき、確認メカニズムとして使用できます。通知をトリガするコンポーネントに <lightning:notificationsLibrary aura:id="notifLib"/> タグを 1 つ含めます。aura:id は、一意のローカル ID です。1 つのタグのみで複数の通知に対応します。

通知

通知はユーザのワークフローを中断し、ページのその他の要素をすべてブロックします。ユーザがアプリケーションを操作できる状態に戻るには、通知を確認する必要があります。その点を踏まえて、通知は慎重に使用してください。レコードを削除する前段階といった、ユーザのアクションを確認する用途には適しません。現在、通知を閉じるには [OK] ボタンしかサポートされていません。

ボタンを含む例を次に示します。クリックされると、ボタンは error バリエーションを含む通知を表示します。

1<aura:component>
2    <lightning:notificationsLibrary aura:id="notifLib"/>
3    <lightning:button name="notice" label="Show Notice" onclick="{!c.handleShowNotice}"/>
4</aura:component>

クライアント側コントローラは、通知を表示します。

1({    
2    handleShowNotice : function(component, event, helper) {
3        component.find('notifLib').showNotice({
4            "variant": "error",
5            "header": "Something has gone wrong!",
6            "message": "Unfortunately, there was a problem updating the record.",
7            closeCallback: function() {
8                alert('You closed the alert!');
9            }
10        });
11    }
12})

通知を作成および表示するには、component.find('notifLib').showNotice() を使用して通知属性を渡します。notifLib は、lightning:notificationsLibrary インスタンスの aura:id に整合します。

属性

属性名	属性型	説明
`header`	String	通知の最上部に表示されるヘッダー。
`title`	String	太字で表示される通知のタイトル。
`message`	String	通知本文のメッセージ。`<br/>` は改行、アンカーはテキストリンクに置換されます。
`variant`	String	通知の外観を変更します。使用できるバリエーションは、`info`、`warning`、`error` です。この値のデフォルトは `info` です。
`closeCallback`	Function	通知が閉じられたときにコールされるコールバック。

トースト

トーストは、通知よりは操作に影響せず、レコードを作成した後のように、アクション後にユーザにフィードバックを提供する場合に適しています。トーストは、閉じることも、定義した期間が経過するまで表示したままにすることもできます。

ボタンを含む例を次に示します。ボタンをクリックすると、info バリエーションを含むトーストが表示されます。これは、終了ボタン (右上の X ) を押すまで表示されたままになります。

1<aura:component>
2    <lightning:notificationsLibrary aura:id="notifLib"/>
3    <lightning:button name="toast" label="Show Toast" onclick="{!c.handleShowToast}"/>
4</aura:component>

クライアント側コントローラは、トーストを表示します。

1({    
2    handleShowToast : function(component, event, helper) {
3        component.find('notifLib').showToast({
4            "title": "Notif library Success!",
5            "message": "The record has been updated successfully."
6        });
7    }
8})

トーストを作成および表示するには、component.find('notifLib').showToast() を使用してトースト属性を渡します。notifLib は、lightning:notificationsLibrary インスタンスの aura:id に整合します。

属性

属性名	属性型	説明
`title`	String	ヘッダーとして表示されるトーストのタイトル。
`message`	String	メッセージを表す文字列。`{0}` ... `{N}` の形式でプレースホルダを含めることができます。このプレースホルダは、メッセージデータのアクションリンクに置換されます。
`messageData`	Object	トーストメッセージテンプレートを置換するインラインアクションリンクの配列。
`variant`	String	トーストの外観を変更します。使用できるバリエーションは、`info`、`success`、`warning`、`error` です。この値のデフォルトは `info` です。
`mode`	String	トーストの表示期間を指定します。デフォルトは `dismissable` です。有効なモードは次のとおりです。 `dismissable`: 終了ボタンが押されるか、3 秒間経過するまで、表示され続けます。 `pester`: 終了ボタンがクリックされるまで表示され続けます。 `sticky`: 3 秒間表示されます。

Lightning コンポーネント開発者ガイド

lightning:notificationsLibrary

通知

トースト