次の方法で共有

スナックバー

  • [アーティクル]

Snackbar は、指定時刻に作動するアラートで、既定で画面の下部に表示されます。 これは、設定が可能な一定時間を経過すると閉じられます。 Snackbar は完全にカスタマイズ可能で、任意の IView に固定できます。

Snackbar では、アプリが実行した、または実行するプロセスを、ユーザーに通知します。 これは、画面の下部に一時的に表示されます。

プラットフォーム固有の初期化

Snackbar 機能にアクセスするには、次のプラットフォーム固有の設定が必要です。

セットアップは必要ありません。

構文

Snackbar は、C# を使用して呼び出されます。

C#

Snackbar を表示するには、静的メソッド Make を使用して、これを作成する必要があります。

using CommunityToolkit.Maui.Alerts;

CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();

var snackbarOptions = new SnackbarOptions
{
    BackgroundColor = Colors.Red,
    TextColor = Colors.Green,
    ActionButtonTextColor = Colors.Yellow,
    CornerRadius = new CornerRadius(10),
    Font = Font.SystemFontOfSize(14),
    ActionButtonFont = Font.SystemFontOfSize(14),
    CharacterSpacing = 0.5
};

string text = "This is a Snackbar";
string actionButtonText = "Click Here to Dismiss";
Action action = async () => await DisplayAlert("Snackbar ActionButton Tapped", "The user has tapped the Snackbar ActionButton", "OK");
TimeSpan duration = TimeSpan.FromSeconds(3);

var snackbar = Snackbar.Make(text, action, actionButtonText, duration, snackbarOptions);

await snackbar.Show(cancellationTokenSource.Token);

Snackbar.Make() を呼び出す際には、そのパラメーター string text が必須です。 その他のパラメーターはすべて省略可能です。

次のスクリーンショットに、Snackbar の結果を示します。

Snackbar を任意の VisualElement に固定する拡張メソッドもあります。

await MyVisualElement.DisplaySnackbar("Snackbar is awesome. It is anchored to MyVisualElement");

警告

Windows 上 の Snackbar は VisualElement に固定することはできません。また、常に既定の Windows 通知として表示されます。

SnackBar には、次の 2 つのイベントが含まれています。

  • public static event EventHandler Shown
  • public static event EventHandler Dismissed

また、プロパティ public static bool IsShown { get; } も含まれています。

Snackbar.Shown += (s, e) => { Console.WriteLine(Snackbar.IsShown); };
Snackbar.Dismissed += (s, e) => { Console.WriteLine(Snackbar.IsShown); };

Properties

プロパティ タイプ 説明
テキスト string テキスト メッセージ。 必須
アクション Action アクション ボタンのクリックで呼び出すアクション。
ActionButtonText string アクション ボタンのテキスト。
アンカー IView Snackbar のアンカー。 Snackbar は、このビューの近くに表示されます。 null の場合、Snackbar は画面の下部に表示されます。
Duration TimeSpan Snackbar の期間。
VisualOptions SnackbarOptions Snackbar のビジュアル オプション。

SnackbarOptions

SnackbarOptions により、既定の Snackbar スタイルをカスタマイズできます。

Properties

プロパティ タイプ 説明 規定値
CharacterSpacing double メッセージの文字間隔。 0.0d
Font Font メッセージのフォント。 Font.SystemFontOfSize(14)
TextColor Color メッセージのテキストの色。 Colors.Black
ActionButtonFont Font アクション ボタンのフォント。 Font.SystemFontOfSize(14)
ActionButtonTextColor Color アクション ボタンのテキストの色。 Colors.Black
BackgroundColor Color 背景色。 Colors.LightGray
CornerRadius CornerRadius 角の半径。 new CornerRadius(4, 4, 4, 4)

メソッド

メソッド 説明
表示 要求された Snackbar を表示します。 これにより、現在表示されている Snackbar はすべて閉じられます
無視 要求された Snackbar を閉じます。

Note

一度に表示できる Snackbar は 1つだけです。 Show メソッドを 2 度目に呼び出すと、最初の Snackbar は、2 番目の Snackbar が表示される前に自動的に閉じられます。

例

この機能の動作状態の例は、.「NET MAUI Community Toolkit サンプル アプリケーション」でご覧になれます。

API

Snackbar のソース コードは、.NET MAUI Community Toolkit の GitHub リポジトリにあります。