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

force:showToast

トースト通知にメッセージを表示します。

トーストによって、ビューの上部のヘッダーの下にメッセージが表示されます。メッセージは message 属性で指定されます。

次の例は、「Success! The record has been updated successfully. (成功! レコードは正常に更新されました。)」というトーストメッセージを表示します。

1showToast : function(component, event, helper) {
2    var toastEvent = $A.get("e.force:showToast");
3    toastEvent.setParams({
4        "title": "Success!",
5        "message": "The record has been updated successfully."
6    });
7    toastEvent.fire();
8}

このイベントは、one.app コンテナによって処理されます。Lightning Experience、Salesforce1、および Lightning コミュニティでサポートされています。

メモ

トーストで使用される背景色とアイコンは、type 属性によって制御されます。たとえば、success に設定すると、トースト通知は緑の背景とチェックマークアイコンで表示されます。mode 属性が dismissible の場合、トーストは 5000 ミリ秒間表示され、右上隅に [閉じる] ボタンが表示されます。

message はテキストのみの文字列をサポートするのに対し、messageTemplate はリンクを含む文字列をサポートします。messageTemplateData で指定した表示ラベルで置き換えられる、プレースホルダの文字列を指定できます。パラメータは、ゼロから順に番号が付けられます。たとえば、{0}、{1}、{2} という 3 つのパラメータがある場合、表示ラベルは指定された順に置換されます。表示ラベルは、アンカータグの title 属性にも使用されます。

次の例では、リンクを含むメッセージのトーストが表示されます。

1showMyToast : function(component, event, helper) {
2    var toastEvent = $A.get("e.force:showToast");
3    toastEvent.setParams({
4        mode: 'sticky',
5        message: 'This is a required message',
6        messageTemplate: 'Record {0} created! See it {1}!',
7        messageTemplateData: ['Salesforce', {
8            url: 'http://www.salesforce.com/',
9            label: 'here',
10            }
11        ]
12    });
13    toastEvent.fire();
14}

属性名	型	説明	必須
`title`	String	太字で表示されるトーストのタイトルを指定します。
`message`	String	表示するメッセージを指定します。	はい
`messageTemplate`	String	指定したメッセージでメッセージ文字列を上書きします。messageTemplateData が必要です。
`messageTemplateData`	Object	messageTemplate で使用されるテキストとアクションの配列。
`key`	String	トースト種別が `other` の場合のアイコンを指定します。アイコンキーは「Lightning Design System Resources」(Lightning Design System のリソース) ページに記載されています。
`duration`	Integer	トーストの期間 (ミリ秒)。デフォルト値は 5000 ミリ秒です。
`type`	String	トースト種別。`error`、`warning`、`success`、`info` のいずれかを指定できます。デフォルトは `other` で、`info` トーストのようなスタイルですが、`key` 属性で指定しない限りアイコンは表示されません。
`mode`	String	トーストモード。ユーザがトーストを消去できる場合の消去方法を制御します。デフォルトは `dismissible` で、[閉じる] ボタンを表示します。有効な値は次のとおりです。 `dismissible`: [閉じる] ボタンを押すか、`duration` が経過するかのいずれかが生じるまで表示されたままになります。 `pester`: `duration` が経過するまで表示されたままになります。[閉じる] ボタンは表示されません。 `sticky`: [閉じる] ボタンを押すまで表示されたままになります。

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

force:showToast