TwoRowsTopAppBarOverrideScope

Parameters available to TwoRowsTopAppBar.

Properties

Link copied to clipboard
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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val modifier: Modifier

the Modifier to be applied to this top app bar

Link copied to clipboard
val navigationIcon: @Composable () -> Unit

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

Link copied to clipboard

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.

Link copied to clipboard
val smallSubtitle: @Composable () -> Unit?
Link copied to clipboard
val smallSubtitleTextStyle: TextStyle
Link copied to clipboard
val smallTitle: @Composable () -> Unit
Link copied to clipboard
val smallTitleTextStyle: TextStyle
Link copied to clipboard
val subtitle: @Composable () -> Unit?

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

Link copied to clipboard
val subtitleTextStyle: TextStyle
Link copied to clipboard
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.

Link copied to clipboard
Link copied to clipboard
val titleHorizontalAlignment: Alignment.Horizontal

the horizontal alignment of the title and subtitle

Link copied to clipboard
val titleTextStyle: TextStyle
Link copied to clipboard
val windowInsets: WindowInsets

a window insets that app bar will respect.

Functions

Link copied to clipboard
@Composable
open override fun TwoRowsTopAppBarOverrideScope.TwoRowsTopAppBar()

Behavior function that is called by the TwoRowsTopAppBar component.