TwoRowsTopAppBarOverrideScope


Parameters available to TwoRowsTopAppBar.

Summary

Public properties

@Composable RowScope.() -> Unit

the actions displayed at the end of the top app bar.

Cmn
Dp

the app bar's height in its collapsed state.

Cmn
TopAppBarColors

TopAppBarColors that will be used to resolve the colors used for this top app bar in different states.

Cmn
Dp

this app bar's height in its expanded state.

Cmn
Modifier

the Modifier to be applied to this top app bar

Cmn
@Composable () -> Unit

the navigation icon displayed at the start of the top app bar.

Cmn
TopAppBarScrollBehavior?

a TopAppBarScrollBehavior which holds various offset values that will be applied by this top app bar to set up its height and colors.

Cmn
(@Composable () -> Unit)?
Cmn
TextStyle
Cmn
@Composable () -> Unit
Cmn
TextStyle
Cmn
(@Composable () -> Unit)?

a lambda for providing an optional subtitle to be displayed in the top app bar in collapsed and expanded states.

Cmn
TextStyle
Cmn
@Composable () -> Unit

a lambda for providing a title to be displayed in the top app bar in collapsed and expanded states.

Cmn
Dp
Cmn
Alignment.Horizontal

the horizontal alignment of the title and subtitle

Cmn
TextStyle
Cmn
WindowInsets

a window insets that app bar will respect.

Cmn

Public properties

actions

val actions: @Composable RowScope.() -> Unit

the actions displayed at the end of the top app bar. This should typically be IconButtons. The default layout here is a Row, so icons inside will be placed horizontally.

collapsedHeight

val collapsedHeightDp

the app bar's height in its collapsed state. Note that this value might be adjusted to support displaying larger fonts. In case the provided value is Dp.Unspecified or Dp.Infinity, the height will default to TopAppBarDefaults.MediumAppBarCollapsedHeight.

colors

val colorsTopAppBarColors

TopAppBarColors that will be used to resolve the colors used for this top app bar in different states. See TopAppBarDefaults.topAppBarColors.

expandedHeight

val expandedHeightDp

this app bar's height in its expanded state. When a specified scrollBehavior causes the app bar to collapse or expand, this value will represent the total height that the app-bar will expand to. The expanded height is expected to be greater or equal to the collapsedHeight, and the function will throw an IllegalArgumentException otherwise. Note that this value might be adjusted to support displaying larger fonts. In case the provided value is Dp.Unspecified or Dp.Infinity, the height will default to TopAppBarDefaults.MediumFlexibleAppBarWithSubtitleExpandedHeight when an expandedSubtitle is provided, or to TopAppBarDefaults.MediumFlexibleAppBarWithoutSubtitleExpandedHeight when it's not.

modifier

val modifierModifier

the Modifier to be applied to this top app bar

val navigationIcon: @Composable () -> Unit

the navigation icon displayed at the start of the top app bar. This should typically be an IconButton or IconToggleButton.

scrollBehavior

val scrollBehaviorTopAppBarScrollBehavior?

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.

smallSubtitle

val smallSubtitle: (@Composable () -> Unit)?

smallSubtitleTextStyle

val smallSubtitleTextStyleTextStyle

smallTitle

val smallTitle: @Composable () -> Unit

smallTitleTextStyle

val smallTitleTextStyleTextStyle

subtitle

val subtitle: (@Composable () -> Unit)?

a lambda for providing an optional subtitle to be displayed in the top app bar in collapsed and expanded states.

subtitleTextStyle

val subtitleTextStyleTextStyle

title

val title: @Composable () -> Unit

a lambda for providing a title to be displayed in the top app bar in collapsed and expanded states. By default a small-app-bar TextStyle is applied to the Composition, and you may override it by wrapping your provided component with a composition local. Note that unlike the large or medium top app bars, the TwoRowsTopAppBar does not append bottom padding to the expanded title Composable by default. Padding should be applied directly to the provided expanded title, or to the subtitle that appears below it.

titleBottomPadding

val titleBottomPaddingDp

titleHorizontalAlignment

val titleHorizontalAlignmentAlignment.Horizontal

the horizontal alignment of the title and subtitle

titleTextStyle

val titleTextStyleTextStyle

windowInsets

val windowInsetsWindowInsets

a window insets that app bar will respect.