DismissState

Kotlin |Java

class DismissState : SwipeableState<DismissValue>

kotlin.Any
↳	androidx.compose.material.SwipeableState<androidx.compose.material.DismissValue>
	↳	androidx.compose.material.DismissState

State of the SwipeToDismiss composable.

Summary

Public constructors
<init>(initialValue: DismissValue, clock: AnimationClockObservable, confirmStateChange: (DismissValue) -> Boolean = { true }) State of the SwipeToDismiss composable.

Public methods
Unit	dismiss(direction: DismissDirection, onDismissed: () -> Unit = null) Dismiss the component in the given direction, with an animation.
Boolean	isDismissed(direction: DismissDirection) Whether the component has been dismissed in the given direction.
Unit	reset(onReset: () -> Unit = null) Reset the component to the default position, with an animation.

Companion functions
Saver<DismissState, DismissValue>	Saver(clock: AnimationClockObservable, confirmStateChange: (DismissValue) -> Boolean) The default Saver implementation for DismissState.

Inherited functions
From class SwipeableState Unit animateTo(targetValue: T, anim: AnimationSpec<Float> = animationSpec, onEnd: (AnimationEndReason, T) -> Unit = null) Set the state to the target value by starting an animation. Unit snapTo(targetValue: T) Set the state to the target value immediately, without any animation.

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

Inherited properties

From class SwipeableState Float direction The direction in which the swipeable is moving, relative to the current value. This will be either 1f if it is is moving from left to right or top to bottom, -1f if it is moving from right to left or bottom to top, or 0f if no swipe or animation is in progress. Boolean isAnimationRunning Whether the state is currently animating. State<Float> offset The current position (in pixels) of the swipeable. You should use this state to offset your content accordingly. The recommended way is to use Modifier.offsetPx. This includes the resistance by default, if resistance is enabled. State<Float> overflow The amount by which the swipeable has been swiped past its bounds. SwipeProgress<T> progress Information about the ongoing swipe or animation, if any. See SwipeProgress for details. If no swipe or animation is in progress, this returns SwipeProgress(value, value, 1f). T targetValue The target value of the state. If a swipe is in progress, this is the value that the swipeable would animate to if the swipe finished. If an animation is running, this is the target value of that animation. Finally, if no swipe or animation is in progress, this is the same as the value. T value The current value of the state. If no swipe or animation is in progress, this corresponds to the anchor at which the swipeable is currently settled. If a swipe or animation is in progress, this corresponds the last anchor at which the swipeable was settled before the swipe or animation started.

Public constructors

<init>

DismissState(
    initialValue: DismissValue, 
    clock: AnimationClockObservable, 
    confirmStateChange: (DismissValue) -> Boolean = { true })

State of the SwipeToDismiss composable.

Parameters
initialValue: DismissValue	The initial value of the state.
clock: AnimationClockObservable	The animation clock that will be used to drive the animations.
confirmStateChange: (DismissValue) -> Boolean = { true }	Optional callback invoked to confirm or veto a pending state change.

Public methods

dismiss

fun dismiss(
    direction: DismissDirection, 
    onDismissed: () -> Unit = null
): Unit

Dismiss the component in the given direction, with an animation.

Parameters
direction: DismissDirection	The dismiss direction.
onDismissed: () -> Unit = null	Optional callback invoked when the component has been dismissed.

isDismissed

fun isDismissed(direction: DismissDirection): Boolean

Whether the component has been dismissed in the given direction.

Parameters
direction: DismissDirection	The dismiss direction.

reset

fun reset(onReset: () -> Unit = null): Unit

Reset the component to the default position, with an animation.

Parameters
onReset: () -> Unit = null	Optional callback invoked when the component has been reset.

Properties

dismissDirection

val dismissDirection: DismissDirection?

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

If the composable is settled at the default state, then this will be null. Use this to change the background of the SwipeToDismiss if you want different actions on each side.

Companion functions

Saver

fun Saver(
    clock: AnimationClockObservable, 
    confirmStateChange: (DismissValue) -> Boolean
): Saver<DismissState, DismissValue>

The default Saver implementation for DismissState.