buttons/ltd.cloudgrid.comments.buttons.swipe/SwipeButtonState

SwipeButtonState

class SwipeButtonState(val confirmThreshold: Float = 0.9f, onComplete: () -> Unit = {}, onReset: () -> Unit = {}, onProgressChanged: (Float) -> Unit = {})

In accordance with the Compose state management pattern, this class encapsulates the physical interaction logic (dragging, progress, and thresholds) while remaining agnostic of the visual styling.

Parameters

confirmThreshold

The normalized value (0.0 to 1.0) that the user must drag beyond to trigger the completion state. Defaults to 0.9 (90%).

onComplete

Callback invoked when the button successfully reaches the completed state.

onReset

Callback invoked when the button is reset from completed to idle.

onProgressChanged

Callback providing real-time updates of the drag progress (0.0 to 1.0).

Constructors

SwipeButtonState

constructor(confirmThreshold: Float = 0.9f, onComplete: () -> Unit = {}, onReset: () -> Unit = {}, onProgressChanged: (Float) -> Unit = {})

Properties

confirmThreshold

val confirmThreshold: Float

var isCompleted: Boolean

Whether the swipe action has been successfully completed. When true, the button typically transforms into a loading or success indicator.

var isDragging: Boolean

Indicates whether the user is currently interacting with the slider.

val swipeProgress: Animatable<Float, AnimationVector1D>

The internal animatable progress of the swipe (0f = start, 1f = end).

Functions

suspend fun animateToRest(animationSpec: AnimationSpec<Float> = spring(stiffness = Spring.StiffnessLow))

Animates the slider back to the start position. Usually called when the user releases the drag before reaching the confirmThreshold.

suspend fun complete(animationSpec: AnimationSpec<Float> = tween(300))

Transitions the state to completed and animates the progress to 100%.

suspend fun forceComplete()

Immediately sets the state to completed without playing an animation.

suspend fun forceReset()

Immediately resets the state to idle without playing an animation.

suspend fun reset(animationSpec: AnimationSpec<Float> = tween(300))

Resets the button to its initial idle state with an animation.

suspend fun updateProgress(value: Float)

Updates the current swipe progress instantly.