SwipeToDismissBoxState

fun Saver(positionalThreshold: (totalDistance: Float) -> Float): Saver<SwipeToDismissBoxState, SwipeToDismissBoxValue>

The default Saver implementation for SwipeToDismissBoxState.

fun Saver(
    confirmValueChange: (SwipeToDismissBoxValue) -> Boolean,
    positionalThreshold: (totalDistance: Float) -> Float,
    density: Density
): Saver<SwipeToDismissBoxState, SwipeToDismissBoxValue>

Saver implementation for SwipeToDismissBoxState.

SwipeToDismissBoxState(
    initialValue: SwipeToDismissBoxValue,
    positionalThreshold: (totalDistance: Float) -> Float
)

State of the SwipeToDismissBox composable.

SwipeToDismissBoxState(
    initialValue: SwipeToDismissBoxValue,
    density: Density,
    confirmValueChange: (SwipeToDismissBoxValue) -> Boolean = { true },
    positionalThreshold: (totalDistance: Float) -> Float
)

State of the SwipeToDismissBox composable.

suspend fun dismiss(direction: SwipeToDismissBoxValue): Unit

Dismiss the component in the given direction, with an animation and suspend. This method will throw CancellationException if the animation is interrupted

fun requireOffset(): Float

Require the current offset.

suspend fun reset(): Unit

Reset the component to the default position with animation and suspend until it if fully reset or animation has been cancelled. This method will throw CancellationException if the animation is interrupted

suspend fun snapTo(targetValue: SwipeToDismissBoxValue): Unit

Set the state without any animation and suspend until it's set

val currentValue: SwipeToDismissBoxValue

The current state value of the SwipeToDismissBoxState.

val dismissDirection: SwipeToDismissBoxValue

The direction (if any) in which the composable has been or is being dismissed.

Use this to change the background of the SwipeToDismissBox if you want different actions on each side.

val progress: Float

The fraction of the progress going from currentValue to targetValue, within 0f..1f bounds.

val settledValue: SwipeToDismissBoxValue

The value the SwipeToDismissBoxState is currently settled at. When progressing through multiple anchors, e.g. A -> B -> C, settledValue will stay the same until settled at an anchor, while currentValue will update to the closest anchor.

val targetValue: SwipeToDismissBoxValue

The target state. This is the closest state to the current offset (taking into account positional thresholds). If no interactions like animations or drags are in progress, this will be the current state.