スナックバー

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

スナックバーを使用する 3 つのユースケースについて考えてみましょう。

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

基本的な例

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

この suspend 関数は、rememberCoroutineScope を使用するなどして CoroutineScope を必要とし、Scaffold 内に Snackbar を表示する UI イベントに応答して呼び出すことができます。

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
}
MaterialLayoutSnippets.kt

アクション付きの Snackbar

任意のアクションを指定し、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
}
MaterialLayoutSnippets.kt

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