← Back to Material 3 Compose
SwipeToDismissBox
Component
in
Material 3
. Since 1.2.0-alpha11Overview
Code Examples
A composable that can be dismissed by swiping left or right.
Overloads
SwipeToDismissBox
@Composable
@ExperimentalMaterial3Api
fun SwipeToDismissBox(
state: DismissState,
backgroundContent: @Composable RowScope.() -> Unit,
modifier: Modifier = Modifier,
directions: Set<DismissDirection> = setOf(EndToStart, StartToEnd),
content: @Composable RowScope.() -> Unit,
)
Parameters
| Name | Description |
|---|---|
state | The state of this component. |
backgroundContent | A composable that is stacked behind the content and is exposed when the content is swiped. You can/should use the state to have different backgrounds on each side. |
content | The content that can be dismissed. |
modifier | Optional Modifier for this component. |
directions | The set of directions in which the component can be dismissed |
