Compose Multiplatform Material3/androidx.compose.material3/ShortNavigationBar

ShortNavigationBar

@Composable

fun ShortNavigationBar(modifier: Modifier = Modifier, containerColor: Color = ShortNavigationBarDefaults.containerColor, contentColor: Color = ShortNavigationBarDefaults.contentColor, windowInsets: WindowInsets = ShortNavigationBarDefaults.windowInsets, arrangement: ShortNavigationBarArrangement = ShortNavigationBarDefaults.arrangement, content: @Composable () -> Unit)

Material Design short navigation bar.

Short navigation bars offer a persistent and convenient way to switch between primary destinations in an app.

Short navigation bar with vertical items
image

Short navigation bar with horizontal items
image

The recommended configuration of the ShortNavigationBar depends on the width size of the screen it's being displayed at:

In small screens, the ShortNavigationBar should contain three to five ShortNavigationBarItems, each representing a singular destination, and its arrangement should be ShortNavigationBarArrangement.EqualWeight, so that the navigation items are equally distributed on the bar.
In medium screens, ShortNavigationBar should contain three to six ShortNavigationBarItems, each representing a singular destination, and its arrangement should be ShortNavigationBarArrangement.Centered, so that the navigation items are distributed grouped on the center of the bar.

A simple example of the first configuration looks like this:

Parameters

modifier

the Modifier to be applied to this navigation bar

containerColor

the color used for the background of this navigation bar. Use Color.Transparent to have no color

contentColor

the color for content inside this navigation bar.

windowInsets

a window insets of the navigation bar

arrangement

the ShortNavigationBarArrangement of this navigation bar

content

the content of this navigation bar, typically ShortNavigationBarItems

Samples

androidx.compose.material3.samples.ShortNavigationBarSampleandroidx.compose.material3.samples.ShortNavigationBarWithHorizontalItemsSample