LargeTopAppBar
Composable Component
Top app bars display information and actions at the top of a screen.

Common
Deprecated Deprecated in favor of LargeTopAppBar with collapsedHeight and expandedHeight parameters
@ExperimentalMaterial3Api
@Composable
fun LargeTopAppBar(
title: @Composable () -> Unit,
modifier: Modifier = Modifier,
navigationIcon: @Composable () -> Unit = {},
actions: @Composable RowScope.() -> Unit = {},
windowInsets: WindowInsets = TopAppBarDefaults.windowInsets,
colors: TopAppBarColors = TopAppBarDefaults.topAppBarColors(),
scrollBehavior: TopAppBarScrollBehavior? = null,
) =
LargeTopAppBar(
title = title,
modifier = modifier,
navigationIcon = navigationIcon,
actions = actions,
collapsedHeight = TopAppBarDefaults.LargeAppBarCollapsedHeight,
expandedHeight = TopAppBarDefaults.LargeAppBarExpandedHeight,
windowInsets = windowInsets,
colors = colors,
scrollBehavior = scrollBehavior,
)
Parameters
title | the title to be displayed in the top app bar. This title will be used in the app bar's expanded and collapsed states, although in its collapsed state it will be composed with a smaller sized TextStyle |
modifier | the Modifier to be applied to this top app bar |
navigationIcon | the navigation icon displayed at the start of the top app bar. This should typically be an IconButton or IconToggleButton . |
actions | the actions displayed at the end of the top app bar. This should typically be IconButton s. The default layout here is a Row , so icons inside will be placed horizontally. |
windowInsets | a window insets that app bar will respect. |
colors | TopAppBarColors that will be used to resolve the colors used for this top app bar in different states. See TopAppBarDefaults.topAppBarColors . |
scrollBehavior | a TopAppBarScrollBehavior which holds various offset values that will be applied by this top app bar to set up its height and colors. A scroll behavior is designed to work in conjunction with a scrolled content to change the top app bar appearance as the content scrolls. See TopAppBarScrollBehavior.nestedScrollConnection . |
Common
@ExperimentalMaterial3Api
@Composable
fun LargeTopAppBar(
title: @Composable () -> Unit,
modifier: Modifier = Modifier,
navigationIcon: @Composable () -> Unit = {},
actions: @Composable RowScope.() -> Unit = {},
collapsedHeight: Dp = TopAppBarDefaults.LargeAppBarCollapsedHeight,
expandedHeight: Dp = TopAppBarDefaults.LargeAppBarExpandedHeight,
windowInsets: WindowInsets = TopAppBarDefaults.windowInsets,
colors: TopAppBarColors = TopAppBarDefaults.topAppBarColors(),
scrollBehavior: TopAppBarScrollBehavior? = null,
) =
TwoRowsTopAppBar(
title = title,
titleTextStyle = AppBarLargeTokens.TitleFont.value,
smallTitleTextStyle = AppBarSmallTokens.TitleFont.value,
titleBottomPadding = LargeTitleBottomPadding,
smallTitle = title,
modifier = modifier,
subtitle = null,
subtitleTextStyle = TextStyle.Default,
smallSubtitle = null,
smallSubtitleTextStyle = TextStyle.Default,
titleHorizontalAlignment = Alignment.Start,
navigationIcon = navigationIcon,
actions = actions,
collapsedHeight =
if (collapsedHeight == Dp.Unspecified || collapsedHeight == Dp.Infinity) {
TopAppBarDefaults.LargeAppBarCollapsedHeight
} else {
collapsedHeight
},
expandedHeight =
if (expandedHeight == Dp.Unspecified || expandedHeight == Dp.Infinity) {
TopAppBarDefaults.LargeAppBarExpandedHeight
} else {
expandedHeight
},
windowInsets = windowInsets,
colors = colors,
scrollBehavior = scrollBehavior,
)
Parameters
title | the title to be displayed in the top app bar. This title will be used in the app bar's expanded and collapsed states, although in its collapsed state it will be composed with a smaller sized TextStyle |
modifier | the Modifier to be applied to this top app bar |
navigationIcon | the navigation icon displayed at the start of the top app bar. This should typically be an IconButton or IconToggleButton . |
actions | the actions displayed at the end of the top app bar. This should typically be IconButton s. The default layout here is a Row , so icons inside will be placed horizontally. |
collapsedHeight | this app bar height when collapsed by a provided scrollBehavior . This value must be specified and finite, otherwise it will be ignored and replaced with TopAppBarDefaults.LargeAppBarCollapsedHeight . |
expandedHeight | this app bar's maximum height. When a specified scrollBehavior causes the app bar to collapse or expand, this value will represent the maximum height that the app-bar will be allowed to expand. The expanded height is expected to be greater or equal to the collapsedHeight , and the function will throw an IllegalArgumentException otherwise. Also, this value must be specified and finite, otherwise it will be ignored and replaced with TopAppBarDefaults.LargeAppBarExpandedHeight . |
windowInsets | a window insets that app bar will respect. |
colors | TopAppBarColors that will be used to resolve the colors used for this top app bar in different states. See TopAppBarDefaults.topAppBarColors . |
scrollBehavior | a TopAppBarScrollBehavior which holds various offset values that will be applied by this top app bar to set up its height and colors. A scroll behavior is designed to work in conjunction with a scrolled content to change the top app bar appearance as the content scrolls. See TopAppBarScrollBehavior.nestedScrollConnection . |
Code Examples
ExitUntilCollapsedLargeTopAppBar
/**
* A sample for a [LargeTopAppBar] that collapses when the content is scrolled up, and appears when
* the content is completely scrolled back down.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Preview
@Composable
fun ExitUntilCollapsedLargeTopAppBar() {
val scrollBehavior = TopAppBarDefaults.exitUntilCollapsedScrollBehavior()
Scaffold(
modifier = Modifier.nestedScroll(scrollBehavior.nestedScrollConnection),
topBar = {
LargeTopAppBar(
title = { Text("Large TopAppBar", maxLines = 1, overflow = TextOverflow.Ellipsis) },
navigationIcon = {
IconButton(onClick = { /* doSomething() */ }) {
Icon(
imageVector = Icons.Filled.Menu,
contentDescription = "Localized description",
)
}
},
actions = {
IconButton(onClick = { /* doSomething() */ }) {
Icon(
imageVector = Icons.Filled.Favorite,
contentDescription = "Localized description",
)
}
},
scrollBehavior = scrollBehavior,
)
},
content = { innerPadding ->
LazyColumn(
contentPadding = innerPadding,
verticalArrangement = Arrangement.spacedBy(8.dp),
) {
val list = (0..75).map { it.toString() }
items(count = list.size) {
Text(
text = list[it],
style = MaterialTheme.typography.bodyLarge,
modifier = Modifier.fillMaxWidth().padding(horizontal = 16.dp),
)
}
}
},
)
}