menuMDUIDocs
color_lens
Material Design 3 と Web Components をベースにした新しい mdui 2 がリリースされました。mdui 2 ドキュメントはこちら

スナックバー

スナックバーは、画面下部に小さなポップアップを表示します。タイムアウト後、またはユーザーが画面の他の場所をクリックまたはタッチした後に自動的に消えます。

画面には一度に1つのスナックバーしか表示できません。スナックバーがまだ閉じられていないときに次のスナックバーを開くと、次のスナックバーはキューに追加され、現在のスナックバーが閉じられた後に開かれます。

使用方法

mdui.snackbar(params) メソッドを呼び出すだけです。

使い方

スナックバーは JavaScript から直接呼び出すため、HTML レイアウトを記述する必要はありません。

スナックバーを呼び出すには2つの方法があります:

  • mdui.snackbar(message, params)
  • mdui.snackbar(params)

どちらの方法もスナックバーのインスタンスを返します。

スナックバーがサポートするパラメーター:

パラメータ名タイプデフォルト値説明
messagestringスナックバーのテキスト。mdui.snackbar(params) で呼び出す場合、このパラメーターは空にできません。
timeoutint4000スナックバーが自動的に隠れるまでの遅延時間(ミリ秒単位)。0 に設定すると自動的に閉じません。
positionstringbottomスナックバーの位置。
  • bottom:下
  • top:上
  • left-top:左上
  • left-bottom:左下
  • right-top:右上
  • right-bottom:右下
buttonTextstringボタンのテキスト。
buttonColorstring#90CAF9ボタンのテキストの色。red#ffffffrgba(255, 255, 255, 0.3) などの色名または色値を指定できます。
closeOnButtonClickbooleantrueボタンをクリックしたときにスナックバーを閉じるかどうか。
closeOnOutsideClickbooleantrueスナックバー以外の領域をクリックまたはタッチしたときにスナックバーを閉じるかどうか。
onClickfunctionスナックバーがクリックされたときのコールバック関数。
onButtonClickfunctionスナックバーのボタンがクリックされたときのコールバック関数。
onOpenfunctionスナックバーが開き始めたときのコールバック関数。
onOpenedfunctionスナックバーが開いた後のコールバック関数。
onClosefunctionスナックバーが閉じ始めたときのコールバック関数。
onClosedfunctionスナックバーが閉じられた後のコールバック関数。

スナックバーのインスタンスが持つメソッド:

メソッド名説明
closeスナックバーを閉じます。閉じられた後、スナックバーは破棄されます。

通常のスナックバー

mdui.snackbar({
  message: 'Message sent'
});

コールバック付きのスナックバー

mdui.snackbar({
  message: 'Archived',
  buttonText: 'undo',
  onClick: function(){
    mdui.alert('スナックバーをクリックしました');
  },
  onButtonClick: function(){
    mdui.alert('ボタンをクリックしました');
  },
  onClose: function(){
    mdui.alert('閉じました');
  }
});

異なる位置のスナックバー

mdui.snackbar({
  message: 'bottom',
  position: 'bottom',
});

mdui.snackbar({
  message: 'top',
  position: 'top',
});

mdui.snackbar({
  message: 'left-top',
  position: 'left-top',
});

mdui.snackbar({
  message: 'left-bottom',
  position: 'left-bottom',
});

mdui.snackbar({
  message: 'right-top',
  position: 'right-top',
});

mdui.snackbar({
  message: 'right-bottom',
  position: 'right-bottom',
});