Compose Multiplatform Material3/androidx.compose.material3/DismissibleNavigationDrawer

DismissibleNavigationDrawer

@Composable
fun DismissibleNavigationDrawer(drawerContent: @Composable () -> Unit, modifier: Modifier = Modifier, drawerState: DrawerState = rememberDrawerState(DrawerValue.Closed), gesturesEnabled: Boolean = true, content: @Composable () -> Unit)

Material Design navigation drawer.

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

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.

Parameters

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 UI

Samples

androidx.compose.material3.samples.DismissibleNavigationDrawerSample