← Back to Compose Multiplatform
DismissibleNavigationDrawer
Component
in
Compose Multiplatform
. Since 1.3.0-beta01
Overview
Examples
Community Notes
Video
<a href="https://m3.material.io/components/navigation-drawer/overview" class="external" target="_blank">Material Design navigation drawer</a>.
Navigation drawers provide ergonomic access to destinations in an app. They’re often next to app content and affect the screen’s layout grid.
!Navigation drawer image(https://developer.android.com/images/reference/androidx/compose/material3/navigation-drawer.png)
Dismissible standard drawers can be used for layouts that prioritize content (such as a photo gallery) or for apps where users are unlikely to switch destinations often. They should use a visible navigation menu icon to open and close the drawer.
Overloads
DismissibleNavigationDrawer
@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun DismissibleNavigationDrawer(
drawerContent: @Composable () -> Unit,
modifier: Modifier = Modifier,
drawerState: DrawerState = rememberDrawerState(DrawerValue.Closed),
gesturesEnabled: Boolean = true,
content: @Composable () -> Unit
)
Parameters
Name | Description |
---|---|
drawerContent | content inside this drawer |
modifier | the Modifier to be applied to this drawer |
drawerState | state of the drawer |
gesturesEnabled | whether or not the drawer can be interacted by gestures |
content | content of the rest of the U |
Previous Component← DismissibleDrawerSheet
Next ComponentDivider →
