ModalDrawerSheet

Component in Material 3 Compose

Content inside of a modal navigation drawer.

Last updated: 2024-10-22 13:47

Installation

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

Overloads

@Composable
fun ModalDrawerSheet(
    modifier: Modifier = Modifier,
    drawerShape: Shape = DrawerDefaults.shape,
    drawerContainerColor: Color = DrawerDefaults.modalContainerColor,
    drawerContentColor: Color = contentColorFor(drawerContainerColor),
    drawerTonalElevation: Dp = DrawerDefaults.ModalDrawerElevation,
    windowInsets: WindowInsets = DrawerDefaults.windowInsets,
    content: @Composable ColumnScope.() -> Unit
)

Parameters

name	description
modifier	the [Modifier] to be applied to this drawer's content
drawerShape	defines the shape of this drawer's container
drawerContainerColor	the color used for the background of this drawer. Use [Color.Transparent] to have no color.
drawerContentColor	the preferred color for content inside this drawer. Defaults to either the matching content color for [drawerContainerColor], or to the current [LocalContentColor] if [drawerContainerColor] is not a color from the theme.
drawerTonalElevation	when [drawerContainerColor] is [ColorScheme.surface], a translucent primary color overlay is applied on top of the container. A higher tonal elevation value will result in a darker color in light theme and lighter color in dark theme. See also: [Surface].
windowInsets	a window insets for the sheet.
content	content inside of a modal navigation drawer

@Composable
fun ModalDrawerSheet(
    drawerState: DrawerState,
    modifier: Modifier = Modifier,
    drawerShape: Shape = DrawerDefaults.shape,
    drawerContainerColor: Color = DrawerDefaults.modalContainerColor,
    drawerContentColor: Color = contentColorFor(drawerContainerColor),
    drawerTonalElevation: Dp = DrawerDefaults.ModalDrawerElevation,
    windowInsets: WindowInsets = DrawerDefaults.windowInsets,
    content: @Composable ColumnScope.() -> Unit
)

Parameters

name	description
drawerState	state of the drawer
modifier	the [Modifier] to be applied to this drawer's content
drawerShape	defines the shape of this drawer's container
drawerContainerColor	the color used for the background of this drawer. Use [Color.Transparent] to have no color.
drawerContentColor	the preferred color for content inside this drawer. Defaults to either the matching content color for [drawerContainerColor], or to the current [LocalContentColor] if [drawerContainerColor] is not a color from the theme.
drawerTonalElevation	when [drawerContainerColor] is [ColorScheme.surface], a translucent primary color overlay is applied on top of the container. A higher tonal elevation value will result in a darker color in light theme and lighter color in dark theme. See also: [Surface].
windowInsets	a window insets for the sheet.
content	content inside of a modal navigation drawer