← Back to Tv Material
NavigationDrawerItem
Component
in
Tv Material
. Since 1.0.0-alpha10Overview
Code Examples
Video
TV Material Design navigation drawer item.
A NavigationDrawerItem represents a destination within drawers, either NavigationDrawer or ModalNavigationDrawer
Overloads
NavigationDrawerItem
@Composable
fun NavigationDrawerScope.NavigationDrawerItem(
selected: Boolean,
onClick: () -> Unit,
leadingContent: @Composable () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
onLongClick: (() -> Unit)? = null,
supportingContent: (@Composable () -> Unit)? = null,
trailingContent: (@Composable () -> Unit)? = null,
tonalElevation: Dp = NavigationDrawerItemDefaults.NavigationDrawerItemElevation,
shape: NavigationDrawerItemShape = NavigationDrawerItemDefaults.shape(),
colors: NavigationDrawerItemColors = NavigationDrawerItemDefaults.colors(),
scale: NavigationDrawerItemScale = NavigationDrawerItemScale.None,
border: NavigationDrawerItemBorder = NavigationDrawerItemDefaults.border(),
glow: NavigationDrawerItemGlow = NavigationDrawerItemDefaults.glow(),
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
content: @Composable () -> Unit,
)
Parameters
Name | Description |
---|---|
selected | defines whether this composable is selected or not |
onClick | called when this composable is clicked |
leadingContent | the leading content of the list item |
modifier | to be applied to the list item |
enabled | controls the enabled state of this composable. When false , this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services |
onLongClick | called when this composable is long clicked (long-pressed) |
supportingContent | the content displayed below the headline content |
trailingContent | the trailing meta badge or icon |
tonalElevation | the tonal elevation of this composable |
shape | defines the shape of Composable's container in different interaction states |
colors | defines the background and content colors used in the composable for different interaction states |
scale | defines the size of the composable relative to its original size in different interaction states |
border | defines a border around the composable in different interaction states |
glow | defines a shadow to be shown behind the composable for different interaction states |
interactionSource | the MutableInteractionSource representing the stream of Interactions for this component. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this composable in different states |
content | main content of this composabl |