New Compose Multiplatform components arrived on Composables UICheck it out →

NavigationRail

A Navigation Rail is a side navigation component that allows movement between primary destinations in an app. A navigation rail should be used to display three to seven app destinations and, optionally, a [FloatingActionButton] or a logo inside [header]. Each destination is typically represented by an icon and an optional text label.

Navigation rail image

Last updated:

Installation

dependencies {
   implementation("androidx.compose.material:material:1.7.0-beta03")
}

Overloads

@Composable
fun NavigationRail(
    windowInsets: WindowInsets,
    modifier: Modifier = Modifier,
    backgroundColor: Color = MaterialTheme.colors.surface,
    contentColor: Color = contentColorFor(backgroundColor),
    elevation: Dp = NavigationRailDefaults.Elevation,
    header: @Composable (ColumnScope.() -> Unit)? = null,
    content: @Composable ColumnScope.() -> Unit
)

Parameters

namedescription
windowInsetsa window insets that navigation rail will respect
modifieroptional [Modifier] for this NavigationRail
backgroundColorThe background color for this NavigationRail
contentColorThe preferred content color provided by this NavigationRail to its children. Defaults to either the matching content color for [backgroundColor], or if [backgroundColor] is not a color from the theme, this will keep the same value set above this NavigationRail.
elevationelevation for this NavigationRail
headeran optional header that may hold a [FloatingActionButton] or a logo
contentdestinations inside this NavigationRail, this should contain multiple [NavigationRailItem]s
@Composable
fun NavigationRail(
    modifier: Modifier = Modifier,
    backgroundColor: Color = MaterialTheme.colors.surface,
    contentColor: Color = contentColorFor(backgroundColor),
    elevation: Dp = NavigationRailDefaults.Elevation,
    header: @Composable (ColumnScope.() -> Unit)? = null,
    content: @Composable ColumnScope.() -> Unit
)

Parameters

namedescription
modifieroptional [Modifier] for this NavigationRail
backgroundColorThe background color for this NavigationRail
contentColorThe preferred content color provided by this NavigationRail to its children. Defaults to either the matching content color for [backgroundColor], or if [backgroundColor] is not a color from the theme, this will keep the same value set above this NavigationRail.
elevationelevation for this NavigationRail
headeran optional header that may hold a [FloatingActionButton] or a logo
contentdestinations inside this NavigationRail, this should contain multiple [NavigationRailItem]s

Code Example

@Composable
@Sampled
fun NavigationRailSample() {
    var selectedItem by remember { mutableStateOf(0) }
    val items = listOf("Home", "Search", "Settings")
    val icons = listOf(Icons.Filled.Home, Icons.Filled.Search, Icons.Filled.Settings)
    NavigationRail(windowInsets = NavigationRailDefaults.windowInsets) {
        items.forEachIndexed { index, item ->
            NavigationRailItem(
                icon = { Icon(icons[index], contentDescription = item) },
                label = { Text(item) },
                selected = selectedItem == index,
                onClick = { selectedItem = index }
            )
        }
    }
}