spark/com.adevinta.spark.components.navigation/NavigationRailItem

NavigationRailItem

@Composable
fun NavigationRailItem(selected: Boolean, onClick: () -> Unit, icon: SparkIcon, modifier: Modifier = Modifier, enabled: Boolean = true, label: String? = null, alwaysShowLabel: Boolean = true, colors: NavigationRailItemColors = NavigationRailItemDefaults.colors(), interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Spark navigation rail item.

A NavigationRailItem represents a destination within a NavigationRail.

Navigation rails provide access to main destinations in apps when using tablet and desktop screens.

The text label is always shown (if it exists) when selected. Showing text labels if not selected is controlled by alwaysShowLabel.

Parameters

selected

whether this item is selected

onClick

called when this item is clicked

icon

icon for this item, typically an Icon

modifier

the Modifier to be applied to this item

enabled

controls the enabled state of this item. When false, this component will not respond to user input, and it will appear visually disabled and 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.

colors

NavigationRailItemColors that will be used to resolve the colors used for this item in different states. See NavigationRailItemDefaults.colors.

interactionSource

the MutableInteractionSource representing the stream of Interactions for this item. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this item in different states.