スナックバー

スナックバー コンポーネントは、画面の下部に表示される簡単な通知として機能します。ユーザー エクスペリエンスを中断することなく、オペレーションやアクションに関するフィードバックを提供します。スナックバーは数秒後に消えます。ユーザーは、ボタンをタップするなどの操作で通知を閉じることもできます。

スナックバーを使用する可能性がある 3 つのユースケースを考えてみましょう。

  • アクションの確認: ユーザーがメールまたはメッセージを削除すると、アクションを確認するスナックバーが表示され、[元に戻す] オプションが表示されます。
  • ネットワーク ステータス: アプリのインターネット接続が失われると、オフラインになったことを示すスナックバーが表示されます。
  • データの送信: フォームの送信または設定の更新が正常に完了すると、変更が正常に保存されたことを示すスナックバーが表示されます。
スナックバー UI コンポーネントの例。
図 1. スナックバーの例。

基本的な例

スナックバーを実装するには、まず SnackbarHost を作成します。これには SnackbarHostState プロパティが含まれます。SnackbarHostState を使用すると、showSnackbar() 関数にアクセスしてスナックバーを表示できます。

この suspend 関数には、rememberCoroutineScope から返されるような CoroutineScope が必要です。また、UI イベントに応じて呼び出して、Scaffold 内に Snackbar を表示できます。

val scope = rememberCoroutineScope()
val snackbarHostState = remember { SnackbarHostState() }
Scaffold(
    snackbarHost = {
        SnackbarHost(hostState = snackbarHostState)
    },
    floatingActionButton = {
        ExtendedFloatingActionButton(
            text = { Text("Show snackbar") },
            icon = { Icon(Icons.Filled.Image, contentDescription = "") },
            onClick = {
                scope.launch {
                    snackbarHostState.showSnackbar("Snackbar")
                }
            }
        )
    }
) { contentPadding ->
    // Screen content
}

アクション付きのスナックバー

任意のアクションを指定し、Snackbar の継続時間を調整できます。snackbarHostState.showSnackbar() 関数は追加の actionLabel パラメータと duration パラメータを受け入れ、SnackbarResult を返します。

val scope = rememberCoroutineScope()
val snackbarHostState = remember { SnackbarHostState() }
Scaffold(
    snackbarHost = {
        SnackbarHost(hostState = snackbarHostState)
    },
    floatingActionButton = {
        ExtendedFloatingActionButton(
            text = { Text("Show snackbar") },
            icon = { Icon(Icons.Filled.Image, contentDescription = "") },
            onClick = {
                scope.launch {
                    val result = snackbarHostState
                        .showSnackbar(
                            message = "Snackbar",
                            actionLabel = "Action",
                            // Defaults to SnackbarDuration.Short
                            duration = SnackbarDuration.Indefinite
                        )
                    when (result) {
                        SnackbarResult.ActionPerformed -> {
                            /* Handle snackbar action performed */
                        }
                        SnackbarResult.Dismissed -> {
                            /* Handle snackbar dismissed */
                        }
                    }
                }
            }
        )
    }
) { contentPadding ->
    // Screen content
}

snackbarHost パラメータでカスタムの Snackbar を指定できます。詳細については、SnackbarHost API リファレンス ドキュメントをご覧ください。

要点

  • actionLabel = "Action": 操作ボタンのテキストを設定します。
  • duration = SnackbarDuration.Indefinite: ユーザーまたはプログラムがスナックバーを閉じるまで、スナックバーを表示したままにします。
  • SnackbarResult.ActionPerformed: ユーザーがスナックバーの操作ボタンをクリックしたことを示します。
  • SnackbarResult.Dismissed: ユーザーが操作ボタンをクリックせずにスナックバーを閉じたことを示します。