ShortNavigationBarItem

Component in Material 3 Compose

Material Design short navigation bar item.

Short navigation bars offer a persistent and convenient way to switch between primary destinations in an app.

It's recommend for navigation items to always have a text label. An [ShortNavigationBarItem] always displays labels (if they exist) when selected and unselected.

Last updated: 2024-10-14 12:17

Installation

dependencies {
   implementation("androidx.compose.material3:material3:1.4.0-alpha01")
}

Overloads

@ExperimentalMaterial3ExpressiveApi
@Composable
fun ShortNavigationBarItem(
    selected: Boolean,
    onClick: () -> Unit,
    icon: @Composable () -> Unit,
    label: @Composable (() -> Unit)?,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    iconPosition: NavigationItemIconPosition = NavigationItemIconPosition.Top,
    colors: NavigationItemColors = ShortNavigationBarItemDefaults.colors(),
    interactionSource: MutableInteractionSource? = null,
)

Parameters

name	description
selected	whether this item is selected
onClick	called when this item is clicked
icon	icon for this item, typically an [Icon]
label	text label for this item
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.
iconPosition	the [NavigationItemIconPosition] for the icon
colors	[NavigationItemColors] that will be used to resolve the colors used for this item in different states. See [ShortNavigationBarItemDefaults.colors]
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.