Compose Multiplatform Material3/androidx.compose.material3/rememberSwipeToDismissBoxState

rememberSwipeToDismissBoxState

@Composable
fun rememberSwipeToDismissBoxState(initialValue: SwipeToDismissBoxValue = SwipeToDismissBoxValue.Settled, confirmValueChange: (SwipeToDismissBoxValue) -> Boolean = { true }, positionalThreshold: (totalDistance: Float) -> Float = SwipeToDismissBoxDefaults.positionalThreshold): SwipeToDismissBoxState

Create and remember a SwipeToDismissBoxState.

Parameters

initialValue

The initial value of the state.

confirmValueChange

Optional callback invoked to confirm or veto a pending state change.

positionalThreshold

The positional threshold to be used when calculating the target state while a swipe is in progress and when settling after the swipe ends. This is the distance from the start of a transition. It will be, depending on the direction of the interaction, added or subtracted from/to the origin offset. It should always be a positive value.