アプリバー

アプリバーは、ユーザーが主要な機能やナビゲーション アイテムにアクセスできるようにするコンテナです。アプリバーには、トップ アプリバーとボトム アプリバーの 2 種類があります。それぞれの外観と目的は次のとおりです。

タイプ

デザイン

目的

トップ アプリバー

画面上部に表示されます。

主要なタスクと情報へのアクセスを提供します。通常、タイトル、コア アクション アイテム、特定のナビゲーション アイテムをホストします。

ボトム アプリバー

画面の下部

通常、主要なナビゲーション項目が含まれます。組み込みのフローティング アクション ボタンなど、その他の主要なアクションへのアクセスを提供することもできます。
上部と下部のアプリバーの例。
図 1. トップ アプリバー（左）とボトム アプリバー（右）。

トップ アプリバーとボトム アプリバーを実装するには、TopAppBar と それぞれ BottomAppBar コンポーザブル。これにより、一貫した ナビゲーション コントロールやアクション コントロールをカプセル化するインターフェース、 マテリアル デザインの原則に沿ったものにします。

トップ アプリバー

次の表に、4 種類のトップ アプリバーの概要を示します。

タイプ

例

小: ナビゲーションやアクションをあまり必要としない画面に使用します。

 トップ アプリバー（小）

中央揃え: メインの操作が 1 つ含まれる画面の場合。

 トップ アプリバーを中央揃え

中: 適度なナビゲーションとアクションが必要な画面に適しています。

 上部のアプリバー（中）

大: 多数のナビゲーションとアクションが必要な画面に適しています。

 大きなトップ アプリバー

API サーフェス

4 つの異なるトップアプリを実装できるさまざまなコンポーザブル 非常に似ています。これらの関数は、次の重要なパラメータを共有しています。

  • title: アプリバー全体に表示されるテキスト。
  • navigationIcon: ナビゲーションのメインアイコン。アプリバーの左側に表示されます。
  • actions: ユーザーが主要なアクションにアクセスできるようにするアイコン。アプリバーの右側に表示されます。
  • scrollBehavior: トップ アプリバーがアプリのスクロールにどう反応するかを決定します 渡します。
  • colors: アプリバーの表示方法を決定します。

スクロールの動作

ユーザーが特定のページをスクロールしたときのアプリバーの反応を制御できます。 スキャフォールドの内部コンテンツを作成しますこれを行うには、TopAppBarScrollBehavior のインスタンスを作成し、トップ アプリバーの scrollBehavior パラメータに渡します。

TopAppBarScrollBehavior には次の 3 種類があります。以下のとおりです:

  • enterAlwaysScrollBehavior: ユーザーがスキャフォールドの内部コンテンツを上に引っ張ると、トップ アプリバーが閉じます。ユーザーが次に進むとアプリバーが展開され、 pull されます。
  • exitUntilCollapsedScrollBehavior: enterAlwaysScrollBehavior と同様に、 ただし、ユーザーがアプリの末尾に到達すると、アプリバーはさらに展開されます。 スキャフォールドの内部コンテンツを作成します
  • pinnedScrollBehavior: アプリバーは表示されたままで、これに反応しません。 使用できます。

次の例では、これらのオプションをいくつか実装しています。

例

以降のセクションでは、スクロール動作を制御する方法のさまざまな例を含め、4 種類のトップアプリバーの実装について説明します。

小

小さなトップ アプリバーを作成するには、TopAppBar コンポーザブルを使用します。これは最もシンプルなトップ アプリバーです。この例では、タイトルのみが含まれています。

次の例では、TopAppBar に scrollBehavior の値が渡されていないため、内部コンテンツのスクロールには反応しません。

@Composable
fun SmallTopAppBarExample() {
    Scaffold(
        topBar = {
            TopAppBar(
                colors = TopAppBarDefaults.topAppBarColors(
                    containerColor = MaterialTheme.colorScheme.primaryContainer,
                    titleContentColor = MaterialTheme.colorScheme.primary,
                ),
                title = {
                    Text("Small Top App Bar")
                }
            )
        },
    ) { innerPadding ->
        ScrollContent(innerPadding)
    }
}
AppBar.kt

これを実装すると次のようになります。

小さなトップ アプリバーの例。
図 2. 小さなトップ アプリバー。

中央揃え

中央に配置されるトップ アプリバーは、小さいアプリバーと基本的に同じです。 コンポーネントの中央に配置されます。実装するには、 専用の CenterAlignedTopAppBar コンポーザブル。

この例では、enterAlwaysScrollBehavior() を使用して scrollBehavior に渡す値を取得します。そのため、ユーザーがスキャフォールドの内部コンテンツをスクロールすると、バーが閉じます。

@Composable
fun CenterAlignedTopAppBarExample() {
    val scrollBehavior = TopAppBarDefaults.pinnedScrollBehavior(rememberTopAppBarState())

    Scaffold(
        modifier = Modifier.nestedScroll(scrollBehavior.nestedScrollConnection),

        topBar = {
            CenterAlignedTopAppBar(
                colors = TopAppBarDefaults.centerAlignedTopAppBarColors(
                    containerColor = MaterialTheme.colorScheme.primaryContainer,
                    titleContentColor = MaterialTheme.colorScheme.primary,
                ),
                title = {
                    Text(
                        "Centered Top App Bar",
                        maxLines = 1,
                        overflow = TextOverflow.Ellipsis
                    )
                },
                navigationIcon = {
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            imageVector = Icons.AutoMirrored.Filled.ArrowBack,
                            contentDescription = "Localized description"
                        )
                    }
                },
                actions = {
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            imageVector = Icons.Filled.Menu,
                            contentDescription = "Localized description"
                        )
                    }
                },
                scrollBehavior = scrollBehavior,
            )
        },
    ) { innerPadding ->
        ScrollContent(innerPadding)
    }
}
AppBar.kt

これを実装すると次のようになります。

ここに代替テキストを入力
図 3. トップ アプリバーが中央に配置されます。

中

上部に中程度のアプリバーでは、タイトルがその他のアイコンの下に配置されます。作成 MediumTopAppBar コンポーザブルを使用します。

前のスニペットと同様に、この例では enterAlwaysScrollBehavior() を使用して、scrollBehavior に渡す値を取得します。

@Composable
fun MediumTopAppBarExample() {
    val scrollBehavior = TopAppBarDefaults.enterAlwaysScrollBehavior(rememberTopAppBarState())

    Scaffold(
        modifier = Modifier.nestedScroll(scrollBehavior.nestedScrollConnection),
        topBar = {
            MediumTopAppBar(
                colors = TopAppBarDefaults.topAppBarColors(
                    containerColor = MaterialTheme.colorScheme.primaryContainer,
                    titleContentColor = MaterialTheme.colorScheme.primary,
                ),
                title = {
                    Text(
                        "Medium Top App Bar",
                        maxLines = 1,
                        overflow = TextOverflow.Ellipsis
                    )
                },
                navigationIcon = {
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            imageVector = Icons.AutoMirrored.Filled.ArrowBack,
                            contentDescription = "Localized description"
                        )
                    }
                },
                actions = {
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            imageVector = Icons.Filled.Menu,
                            contentDescription = "Localized description"
                        )
                    }
                },
                scrollBehavior = scrollBehavior
            )
        },
    ) { innerPadding ->
        ScrollContent(innerPadding)
    }
}
AppBar.kt

この実装は次のようになります。enterAlwaysScrollBehavior() のスクロール動作がどのように表示されるかを示しています。

図 4. トップ アプリバーが中央に配置されます。

大

大きなトップ アプリバーは Medium に似ていますが、 タイトルとアイコンが大きくなります。また、画面全体で多くのスペースを占めます。宛先 LargeTopAppBar コンポーザブルを使用します。

前のスニペットとは異なり、この例では exitUntilCollapsedScrollBehavior() が渡される値を取得する scrollBehavior。そのため、ユーザーがスキャフォールドの内部コンテンツをスクロールするとバーは閉じますが、ユーザーが内部コンテンツの最後までスクロールするとバーは開きます。

@Composable
fun LargeTopAppBarExample() {
    val scrollBehavior = TopAppBarDefaults.exitUntilCollapsedScrollBehavior(rememberTopAppBarState())

    Scaffold(
        modifier = Modifier.nestedScroll(scrollBehavior.nestedScrollConnection),
        topBar = {
            LargeTopAppBar(
                colors = TopAppBarDefaults.topAppBarColors(
                    containerColor = MaterialTheme.colorScheme.primaryContainer,
                    titleContentColor = MaterialTheme.colorScheme.primary,
                ),
                title = {
                    Text(
                        "Large Top App Bar",
                        maxLines = 1,
                        overflow = TextOverflow.Ellipsis
                    )
                },
                navigationIcon = {
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            imageVector = Icons.AutoMirrored.Filled.ArrowBack,
                            contentDescription = "Localized description"
                        )
                    }
                },
                actions = {
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            imageVector = Icons.Filled.Menu,
                            contentDescription = "Localized description"
                        )
                    }
                },
                scrollBehavior = scrollBehavior
            )
        },
    ) { innerPadding ->
        ScrollContent(innerPadding)
    }
}
AppBar.kt

これを実装すると次のようになります。

左側にアクション アイコン、右側にフローティング アクション ボタンがあるボトム アプリバーがあるアプリの画面。
図 5. 大きなトップ アプリバーの実装例。

ボトム アプリバー

ボトム アプリバーを作成するには、BottomAppBar コンポーザブルを使用します。こちらの このコンポーザブルは、このモジュールで説明したトップ アプリバーのコンポーザブルとよく似ています。 ご覧ください。次のキーのコンポーザブルを渡します。 parameters:

  • actions: バーの左側に表示される一連のアイコン。通常、これらは特定の画面の主要なアクションまたはナビゲーション アイテムです。
  • floatingActionButton: バーの右側に表示されるフローティング アクション ボタン。

@Composable
fun BottomAppBarExample() {
    Scaffold(
        bottomBar = {
            BottomAppBar(
                actions = {
                    IconButton(onClick = { /* do something */ }) {
                        Icon(Icons.Filled.Check, contentDescription = "Localized description")
                    }
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            Icons.Filled.Edit,
                            contentDescription = "Localized description",
                        )
                    }
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            Icons.Filled.Mic,
                            contentDescription = "Localized description",
                        )
                    }
                    IconButton(onClick = { /* do something */ }) {
                        Icon(
                            Icons.Filled.Image,
                            contentDescription = "Localized description",
                        )
                    }
                },
                floatingActionButton = {
                    FloatingActionButton(
                        onClick = { /* do something */ },
                        containerColor = BottomAppBarDefaults.bottomAppBarFabColor,
                        elevation = FloatingActionButtonDefaults.bottomAppBarFabElevation()
                    ) {
                        Icon(Icons.Filled.Add, "Localized description")
                    }
                }
            )
        },
    ) { innerPadding ->
        Text(
            modifier = Modifier.padding(innerPadding),
            text = "Example of a scaffold with a bottom app bar."
        )
    }
}
AppBar.kt

これを実装すると次のようになります。

左側にアクション アイコン、右側にフローティング アクション ボタンがあるボトム アプリバーがあるアプリの画面。
図 6. ボトム アプリバーの実装例。
で確認できます。

参考情報