アプリバーは、ユーザーが主な機能やナビゲーション アイテムにアクセスできるようにするコンテナです。アプリバーには、トップ アプリバーとボトム アプリバーの 2 種類があります。それぞれの外観と目的は次のとおりです。
タイプ |
デザイン |
目的 |
|---|---|---|
トップ アプリバー |
画面の上部 |
主要なタスクと情報へのアクセスを提供します。通常は、タイトル、コア アクション アイテム、特定のナビゲーション アイテムをホストします。 |
ボトム アプリバー |
画面下部 |
通常、主要なナビゲーション アイテムが含まれます。フローティング アクション ボタンなど、その他の重要なアクションにアクセスできるようにすることも可能です。 |
トップ アプリバーとボトム アプリバーを実装するには、それぞれ TopAppBar コンポーザブルと BottomAppBar コンポーザブルを使用します。これにより、ナビゲーションとアクション コントロールをカプセル化し、マテリアル デザインの原則に沿った一貫性のあるインターフェースを作成できます。
上位のアプリバー
次の表は、4 種類のトップ アプリバーの概要を示しています。
タイプ |
例 |
|---|---|
小: 多くの操作や操作を必要としない画面向け。 |
|
中央揃え: 単一のメイン アクションがある画面の場合。 |
|
中: 中程度のナビゲーションとアクションが必要な画面向け。 |
|
大: 多くのナビゲーションとアクションを必要とする画面向け。 |
|
API サーフェス
4 つの異なるトップ アプリバーを実装できるさまざまなコンポーザブルは、非常によく似ています。この 2 つには、次のような重要なパラメータがあります。
title: アプリバー全体に表示されるテキスト。navigationIcon: ナビゲーションのメイン アイコン。アプリバーの左側に表示されます。actions: ユーザーが主要なアクションにアクセスできるようにするアイコン。これらはアプリバーの右側に表示されます。scrollBehavior: スキャフォールドの内部コンテンツのスクロールに対するトップ アプリバーの応答方法を指定します。colors: アプリバーの表示方法を指定します。
スクロール動作
特定のスキャフォールドの内部コンテンツをユーザーがスクロールしたときのアプリバーの反応を制御できます。そのためには、TopAppBarScrollBehavior のインスタンスを作成し、そのインスタンスをトップ アプリバーの scrollBehavior パラメータに渡します。
TopAppBarScrollBehavior には 3 つのタイプがあります。以下のとおりです:
enterAlwaysScrollBehavior: ユーザーがスキャフォールドの内部コンテンツを引き上げると、トップ アプリバーが閉じます。ユーザーが内部コンテンツをプルダウンすると、アプリバーが拡大します。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)
}
}
これを実装すると次のようになります。
中央揃え
中央に配置されたトップ アプリバーは、小さなアプリバーと基本的に同じですが、タイトルはコンポーネント内で中央に配置されます。これを実装するには、専用の CenterAlignedTopAppBar コンポーザブルを使用します。
この例では、enterAlwaysScrollBehavior() を使用して scrollBehavior に渡す値を取得します。そのため、ユーザーがスキャフォールドの内部コンテンツをスクロールすると、バーは閉じます。
@Composable
fun CenterAlignedTopAppBarExample() {
val scrollBehavior = TopAppBarDefaults.pinnedScrollBehavior(rememberTopAppBarState())
Scaffold(
modifier = Modifier.nestedScroll(scrollBehavior.nestedScrollConnection),
topBar = {
CenterAlignedTopAppBar(
colors = TopAppBarDefaults.topAppBarColors(
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.Filled.ArrowBack,
contentDescription = "Localized description"
)
}
},
actions = {
IconButton(onClick = { /* do something */ }) {
Icon(
imageVector = Icons.Filled.Menu,
contentDescription = "Localized description"
)
}
},
scrollBehavior = scrollBehavior,
)
},
) { innerPadding ->
ScrollContent(innerPadding)
}
}
これを実装すると次のようになります。
Medium
中程度のトップ アプリバーでは、他のアイコンの下にタイトルが配置されます。作成するには、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.Filled.ArrowBack,
contentDescription = "Localized description"
)
}
},
actions = {
IconButton(onClick = { /* do something */ }) {
Icon(
imageVector = Icons.Filled.Menu,
contentDescription = "Localized description"
)
}
},
scrollBehavior = scrollBehavior
)
},
) { innerPadding ->
ScrollContent(innerPadding)
}
}
この実装は次のようになります。enterAlwaysScrollBehavior() からのスクロール動作の表示例を次に示します。
大
トップ アプリバーは中サイズに似ていますが、タイトルとアイコンの間のパディングは大きく、画面上で占めるスペースは大きくなります。作成するには、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.Filled.ArrowBack,
contentDescription = "Localized description"
)
}
},
actions = {
IconButton(onClick = { /* do something */ }) {
Icon(
imageVector = Icons.Filled.Menu,
contentDescription = "Localized description"
)
}
},
scrollBehavior = scrollBehavior
)
},
) { innerPadding ->
ScrollContent(innerPadding)
}
}
これを実装すると次のようになります。
ボトム アプリバー
ボトム アプリバーを作成するには、BottomAppBar コンポーザブルを使用します。このコンポーザブルの使用方法は、このページの前のセクションで説明したトップ アプリバー コンポーザブルとよく似ています。次のキーパラメータにコンポーザブルを渡します。
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."
)
}
}
これを実装すると次のようになります。
