アプリバーは、主要な機能やナビゲーション アイテムへのユーザー アクセスを提供するコンテナです。アプリバーには、トップ アプリバーとボトム アプリバーの 2 種類があります。それぞれの外観と目的は次のとおりです。
種類 |
デザイン |
目的 |
|---|---|---|
トップ アプリバー |
画面上部 |
主要なタスクと情報へのアクセスを提供します。通常、タイトル、コア アクション アイテム、特定のナビゲーション アイテムをホストします。 |
ボトム アプリバー |
画面の下部 |
通常、主要なナビゲーション項目が含まれます。組み込みのフローティング アクション ボタンなど、その他の主要なアクションへのアクセスを提供することもできます。 |
トップ アプリバーとボトム アプリバーを実装するには、それぞれ TopAppBar コンポーザブルと BottomAppBar コンポーザブルを使用します。これにより、ナビゲーションとアクションのコントロールをカプセル化し、マテリアル デザインの原則に沿った一貫したインターフェースを作成できます。
トップ アプリバー
次の表に、4 種類のトップ アプリバーの概要を示します。
種類 |
例 |
|---|---|
小: 多くのナビゲーションやアクションを必要としない画面向け。 |
|
中央揃え: メインの操作が 1 つ含まれる画面の場合。 |
|
中: 適度なナビゲーションとアクションが必要な画面に適しています。 |
|
大: 多数のナビゲーションとアクションが必要な画面に適しています。 |
|
API サーフェス
4 つの異なるトップ アプリバーを実装できるさまざまなコンポーザブルは非常に類似しています。共通する重要なパラメータは次のとおりです。
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.AutoMirrored.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.AutoMirrored.Filled.ArrowBack,
contentDescription = "Localized description"
)
}
},
actions = {
IconButton(onClick = { /* do something */ }) {
Icon(
imageVector = Icons.Filled.Menu,
contentDescription = "Localized description"
)
}
},
scrollBehavior = scrollBehavior
)
},
) { innerPadding ->
ScrollContent(innerPadding)
}
}
この実装は次のように表示されます。ここでは、enterAlwaysScrollBehavior() からのスクロール動作がどのように表示されます。
大
大きなトップ アプリバーは 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)
}
}
これを実装すると次のようになります。
ボトム アプリバー
ボトム アプリバーを作成するには、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."
)
}
}
これを実装すると次のようになります。
