NavigationRailItem

Common/AllAndroid/JVM

Functions summary

Unit

@Composable NavigationRailItem(     selected: Boolean,     onClick: () -> Unit,     icon: @Composable () -> Unit,     modifier: Modifier,     enabled: Boolean,     label: (@Composable () -> Unit)?,     alwaysShowLabel: Boolean,     interactionSource: MutableInteractionSource?,     selectedContentColor: Color,     unselectedContentColor: Color ) Material Design navigation rail

Cmn

Functions

NavigationRailItem

Cmn

Artifact: androidx.compose.material:material

View Source

Added in 1.10.0

@Composable
fun NavigationRailItem(
    selected: Boolean,
    onClick: () -> Unit,
    icon: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    label: (@Composable () -> Unit)? = null,
    alwaysShowLabel: Boolean = true,
    interactionSource: MutableInteractionSource? = null,
    selectedContentColor: Color = MaterialTheme.colors.primary,
    unselectedContentColor: Color = LocalContentColor.current.copy(alpha = ContentAlpha.medium)
): Unit

Material Design navigation rail

A NavigationRailItem always shows text labels (if it exists) when selected. Showing text labels if not selected is controlled by alwaysShowLabel.

Parameters
selected: Boolean	whether this item is selected (active)
onClick: () -> Unit	the callback to be invoked when this item is selected
icon: @Composable () -> Unit	icon for this item, typically this will be an Icon
modifier: Modifier = Modifier	optional Modifier for this item
enabled: Boolean = true	controls the enabled state of this item. When false, this item will not be clickable and will appear disabled to accessibility services.
label: (@Composable () -> Unit)? = null	optional text label for this item
alwaysShowLabel: Boolean = true	whether to always show the label for this item. If false, the label will only be shown when this item is selected.
interactionSource: MutableInteractionSource? = null	an optional hoisted MutableInteractionSource for observing and emitting Interactions for this item. You can use this to change the item's appearance or preview the item in different states. Note that if null is provided, interactions will still happen internally.
selectedContentColor: Color = MaterialTheme.colors.primary	the color of the text label and icon when this item is selected, and the color of the ripple.
unselectedContentColor: Color = LocalContentColor.current.copy(alpha = ContentAlpha.medium)	the color of the text label and icon when this item is not selected