RevealState

Class

Android

Deprecated The SwipeToReveal component from the latest material library should be used instead. This will be removed in a future release of this library.

@ExperimentalWearFoundationApi
public class RevealState
internal constructor(
    initialValue: RevealValue,
    animationSpec: AnimationSpec<Float>,
    confirmValueChange: (RevealValue) -> Boolean,
    positionalThreshold: (totalDistance: Float) -> Float,
    internal val anchors: Map<RevealValue, Float>,
    internal val coroutineScope: CoroutineScope,
    internal val nestedScrollDispatcher: NestedScrollDispatcher,
)

A class to keep track of the state of the composable. It can be used to customise the behavior and state of the composable.

Functions

public suspend fun snapTo(targetValue: RevealValue)

Snaps to the targetValue without any animation.

Parameters

targetValueThe target RevealValue where the currentValue will be changed to.
public suspend fun animateTo(targetValue: RevealValue)

Animates to the targetValue with the animation spec provided.

Parameters

targetValueThe target RevealValue where the currentValue will animate to.