State of Compose 2023 results are in! Click here to learn more

← Back to Material 3 Compose

DismissibleDrawerSheet

Component
in
Material 3
. Since 1.0.0

Overview

Code Examples

Content inside of a dismissible navigation drawer.

@param modifier the Modifier to be applied to this drawer's content @param drawerShape defines the shape of this drawer's container @param drawerContainerColor the color used for the background of this drawer. Use Color.Transparent to have no color. @param 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. @param 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. @param windowInsets a window insets for the sheet. @param content content inside of a dismissible navigation drawer

Overloads

DismissibleDrawerSheet

@Composable
fun DismissibleDrawerSheet(
    modifier: Modifier = Modifier,
    drawerShape: Shape = RectangleShape,
    drawerContainerColor: Color = MaterialTheme.colorScheme.surface,
    drawerContentColor: Color = contentColorFor(drawerContainerColor),
    drawerTonalElevation: Dp = DrawerDefaults.DismissibleDrawerElevation,
    windowInsets: WindowInsets = DrawerDefaults.windowInsets,
    content: @Composable ColumnScope.() -> Unit
)

Parameters

NameDescription
modifierthe Modifier to be applied to this drawer's content
drawerShapedefines the shape of this drawer's container
drawerContainerColorthe color used for the background of this drawer. Use Color.Transparent to have no color.
drawerContentColorthe 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.
drawerTonalElevationwhen 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.
windowInsetsa window insets for the sheet.
contentcontent inside of a dismissible navigation drawe