← Compose Multiplatform Component in Material 3 Compose
DismissibleDrawerSheet
Common
Content inside of a dismissible navigation drawer.
Last updated:
Installation
dependencies {
implementation("androidx.compose.material3:material3:1.3.0-beta04")
}
Overloads
@Composable
fun DismissibleDrawerSheet(
modifier: Modifier = Modifier,
drawerShape: Shape = RectangleShape,
drawerContainerColor: Color = DrawerDefaults.standardContainerColor,
drawerContentColor: Color = contentColorFor(drawerContainerColor),
drawerTonalElevation: Dp = DrawerDefaults.DismissibleDrawerElevation,
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 dismissible navigation drawer |
@Composable
fun DismissibleDrawerSheet(
drawerState: DrawerState,
modifier: Modifier = Modifier,
drawerShape: Shape = RectangleShape,
drawerContainerColor: Color = DrawerDefaults.standardContainerColor,
drawerContentColor: Color = contentColorFor(drawerContainerColor),
drawerTonalElevation: Dp = DrawerDefaults.DismissibleDrawerElevation,
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 dismissible navigation drawer |
