Toast
Toastは、ユーザーに一時的なメッセージを通知するコンポーネントです。
アクション部分はsnippet action()
で差し替えられ、6方向の表示位置に対応しています。
位置に応じてスライド方向が変化するアニメーションで表示されます。
プロパティ
Toastは、以下のプロパティをサポートしています。
名前 | 型 | デフォルト値 | 説明 |
---|---|---|---|
position |
string |
top-center |
表示位置を指定できます。top-right , top-left , bottom-right , bottom-left , top-center , bottom-center のいずれかを選択できます。 |
duration |
number |
3000 |
自動で閉じるまでの時間をミリ秒で指定します。 |
keepOpen |
boolean |
false |
trueを指定することでトーストを自動で閉じなくします。 |
hideCloseButton |
boolean |
false |
trueを指定すると閉じるボタンを非表示にします。 |
transitionParams |
FlyParams |
{duration: 200, x: 0, y: 0} |
アニメーションの時間・水平方向移動距離・垂直方向移動距離を指定できます。 |
closeButtonClass |
string |
閉じるアイコンのクラスを指定できます。 | |
open |
boolean |
true |
トーストの開閉状態を制御します。 |
onClose |
() => void |
トーストが閉じられたときに呼ばれるハンドラです。 |
インストールの手順
以下のコンポーネントのコードを、使いたいプロジェクトにコピー&ペーストします。
パスは実際のプロジェクトの構成にあわせて更新します。
依存コンポーネント
Toastを使うときは、以下のコンポーネントもダウンロードが必要です。
使い方
サンプル
Auto Close
duration
に指定した時間が経過後に自動でToastを閉じます。
Auto Close with Action
自動で閉じるほか、 閉じるボタンによって閉じることができます。
Persistent
keepOpen
を true
にすると、操作されるまで表示され続けます。
Positions
6方向の表示位置に対応しています。