Compose Multiplatform Material3/androidx.compose.material3/SwipeToDismissBoxState

SwipeToDismissBoxState

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

State of the SwipeToDismissBox composable.

Parameters

initialValue

The initial value of the state.

density

The density that this state can use to convert values to and from dp.

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.

Constructors

SwipeToDismissBoxState

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

Types

Companion

object Companion

Properties

currentValue

val currentValue: SwipeToDismissBoxValue

The current state value of the SwipeToDismissBoxState.

dismissDirection

val dismissDirection: SwipeToDismissBoxValue

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

progress

@get:FloatRange(from = 0.0, to = 1.0)

val progress: Float

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

targetValue

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.

Functions

dismiss

suspend fun dismiss(direction: SwipeToDismissBoxValue)

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

requireOffset

fun requireOffset(): Float

Require the current offset.

reset

suspend fun reset()

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

snapTo

suspend fun snapTo(targetValue: SwipeToDismissBoxValue)

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