rememberSwipeableState

Functions summary

SwipeableState<T>
@Composable
@ExperimentalWearMaterialApi
<T : Any> rememberSwipeableState(
    initialValue: T,
    animationSpec: AnimationSpec<Float>,
    confirmStateChange: (newValue) -> Boolean
)

Create and remember a SwipeableState with the default animation clock.

Functions

rememberSwipeableState

@Composable
@ExperimentalWearMaterialApi
fun <T : Any> rememberSwipeableState(
    initialValue: T,
    animationSpec: AnimationSpec<Float> = SwipeableDefaults.AnimationSpec,
    confirmStateChange: (newValue) -> Boolean = { true }
): SwipeableState<T>

Create and remember a SwipeableState with the default animation clock.

Parameters
initialValue: T

The initial value of the state.
animationSpec: AnimationSpec<Float> = SwipeableDefaults.AnimationSpec

The default animation that will be used to animate to a new state.
confirmStateChange: (newValue) -> Boolean = { true }

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