Composable Component

AppBarColumn

An AppBarColumn arranges its children in a vertical sequence, and if any children overflow the constraints, an overflow indicator is displayed.

Source set: Common

Added in 1.5.0-alpha17

@Composable
fun AppBarColumn(
    modifier: Modifier = Modifier,
    overflowIndicator: @Composable (AppBarMenuState) -> Unit = { menuState ->
        AppBarOverflowIndicator(menuState)
    },
    maxItemCount: Int = Int.MAX_VALUE,
    content: AppBarColumnScope.() -> Unit,
)

Parameters
modifier The modifier to be applied to the column.
overflowIndicator A composable that is displayed at the end of the column when the content overflows. It receives an AppBarMenuState instance.
maxItemCount the max amount of items that should render in the column, before starting to use the overflow menu. Consider that using large items or small constraints, will reduce the effective maximum. Note: If the number of items supplied is bigger than max, at most max - 1 items will render, since the last one will be dedicated to the overflow composable.
content The content to be arranged in the column, defined using a dsl with AppBarColumnScope.

Deprecated

Maintained for binary compatibility.

Source set: Common

Added in 1.5.0-alpha17

Deprecated in 1.5.0-alpha17

@Composable
fun AppBarColumn(
    overflowIndicator: @Composable (AppBarMenuState) -> Unit,
    modifier: Modifier = Modifier,
    maxItemCount: Int = Int.MAX_VALUE,
    content: AppBarColumnScope.() -> Unit,
) = AppBarColumn(modifier, overflowIndicator, maxItemCount, content)