spark/com.adevinta.spark.components.bottomsheet.layout/SwipeableState

SwipeableState

open class SwipeableState<T>(initialValue: T, animationSpec: AnimationSpec<Float> = AnimationSpec, val confirmStateChange: (newValue: T) -> Boolean = { true })

State of the swipeable modifier.

This contains necessary information about any ongoing swipe or animation and provides methods to change the state either immediately or by starting an animation. To create and remember a SwipeableState with the default animation clock, use rememberSwipeableState.

Parameters

initialValue

The initial value of the state.

animationSpec

The default animation that will be used to animate to a new state.

confirmStateChange

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

Constructors

constructor(initialValue: T, animationSpec: AnimationSpec<Float> = AnimationSpec, confirmStateChange: (newValue: T) -> Boolean = { true })

Types

object Companion

Properties

confirmStateChange

val confirmStateChange: (newValue: T) -> Boolean

var currentValue: T

The current value of the state.

isAnimationRunning

var isAnimationRunning: Boolean

Whether the state is currently animating.

val offset: State<Float>

The current position (in pixels) of the swipeable.

val overflow: State<Float>

The amount by which the swipeable has been swiped past its bounds.

PreUpPostDownNestedScrollConnection

val <T> SwipeableState<T>.PreUpPostDownNestedScrollConnection: NestedScrollConnection

val targetValue: T

The target value of the state.

Functions

suspend fun animateTo(targetValue: T, anim: AnimationSpec<Float> = animationSpec)

Set the state to the target value by starting an animation.