OudsNavigationBarItem

fun RowScope.OudsNavigationBarItem(selected: Boolean, onClick: () -> Unit, icon: OudsNavigationBarItem.Icon, modifier: Modifier = Modifier, label: String? = null, enabled: Boolean = true, badge: OudsNavigationBarItem.Badge? = null, alwaysShowLabel: Boolean = true, interactionSource: MutableInteractionSource? = null)

An OUDS navigation bar item.

It must be used in OudsNavigationBar.

The recommended configuration for an OudsNavigationBarItem depends on how many items there are inside a OudsNavigationBarItem:

Three destinations: Display icons and text labels for all destinations.
Four destinations: Active destinations display an icon and text label. Inactive destinations display icons, and text labels are recommended.
Five destinations: Active destinations display an icon and text label. Inactive destinations use icons, and use text labels if space permits.

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

selected

Whether this item is selected or not.

onClick

Called when this item is clicked.

icon

Icon of the item.

modifier

Modifier applied to the navigation bar item.

label

Label of the item.

enabled

Controls the enabled state of the item. When false, the item will not be clickable.

badge

Optional badge display on the item icon.

alwaysShowLabel

Whether the label should always be shown.

interactionSource

MutableInteractionSource that will be used to dispatch events when this item is pressed, hovered or focused.