NavigationRailItem

Component in Material Compose

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

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.compose.material:material:1.8.0-alpha04")
}

Overloads

@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)
)

Parameters

name	description
selected	whether this item is selected (active)
onClick	the callback to be invoked when this item is selected
icon	icon for this item, typically this will be an [Icon]
modifier	optional [Modifier] for this item
enabled	controls the enabled state of this item. When false, this item will not be clickable and will appear disabled to accessibility services.
label	optional text label for this item
alwaysShowLabel	whether to always show the label for this item. If false, the label will only be shown when this item is selected.
interactionSource	an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s 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	the color of the text label and icon when this item is selected, and the color of the ripple.
unselectedContentColor	the color of the text label and icon when this item is not selected