DismissState

Artifact: androidx.compose.material:material

Added in 1.0.0

Cmn

@ExperimentalMaterialApi
class DismissState : SwipeableState

kotlin.Any
↳	androidx.compose.material.SwipeableState
	↳	androidx.compose.material.DismissState

State of the SwipeToDismiss composable.

Summary

Public companion functions
`Saver<DismissState, DismissValue>`	`Saver(confirmStateChange: (DismissValue) -> Boolean)` The default `Saver` implementation for `DismissState`.	Cmn

Public constructors
`DismissState( initialValue: DismissValue, confirmStateChange: (DismissValue) -> Boolean )`	Cmn

Public functions
`suspend Unit`	`dismiss(direction: DismissDirection)` Dismiss the component in the given `direction`, with an animation and suspend.	Cmn
`Boolean`	`isDismissed(direction: DismissDirection)` Whether the component has been dismissed in the given `direction`.	Cmn
`suspend Unit`	`reset()` Reset the component to the default position with animation and suspend until it if fully reset or animation has been cancelled.	Cmn

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

Inherited functions

From androidx.compose.material.SwipeableState

`suspend Unit`	`@ExperimentalMaterialApi animateTo(targetValue: DismissValue, anim: AnimationSpec<Float>)` Set the state to the target value by starting an animation.	Cmn
`Float`	`performDrag(delta: Float)` Force `swipeable` to consume drag delta provided from outside of the regular `swipeable` gesture flow.	Cmn
`suspend Unit`	`performFling(velocity: Float)` Perform fling with settling to one of the anchors which is determined by the given `velocity`.	Cmn
`suspend Unit`	`@ExperimentalMaterialApi snapTo(targetValue: DismissValue)` Set the state without any animation and suspend until it's set	Cmn

Inherited properties

From androidx.compose.material.SwipeableState

`DismissValue`	`currentValue` The current value of the state.	Cmn
`Float`	`@ExperimentalMaterialApi direction` The direction in which the `swipeable` is moving, relative to the current `currentValue`.	Cmn
`Boolean`	`isAnimationRunning` Whether the state is currently animating.	Cmn
`State<Float>`	`offset` The current position (in pixels) of the `swipeable`.	Cmn
`State<Float>`	`overflow` The amount by which the `swipeable` has been swiped past its bounds.	Cmn
`SwipeProgress<DismissValue>`	`@ExperimentalMaterialApi progress` Information about the ongoing swipe or animation, if any.	Cmn
`DismissValue`	`@ExperimentalMaterialApi targetValue` The target value of the state.	Cmn

Public companion functions

Saver

Cmn

Added in 1.0.0

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

The default Saver implementation for DismissState.

Public constructors

DismissState

Cmn

Added in 1.0.0

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

Parameters
`initialValue: DismissValue`	The initial value of the state.
`confirmStateChange: (DismissValue) -> Boolean = { true }`	Optional callback invoked to confirm or veto a pending state change.

Public functions

dismiss

Cmn

Added in 1.0.0

suspend fun dismiss(direction: DismissDirection): Unit

Dismiss the component in the given direction, with an animation and suspend. This method will throw CancellationException if the animation is interrupted

Parameters
`direction: DismissDirection`	The dismiss direction.

isDismissed

Cmn

Added in 1.0.0

fun isDismissed(direction: DismissDirection): Boolean

Whether the component has been dismissed in the given direction.

Parameters
`direction: DismissDirection`	The dismiss direction.

reset

Cmn

Added in 1.0.0

suspend fun reset(): Unit

Reset the component to the default position with animation and suspend until it if fully reset or animation has been cancelled. This method will throw CancellationException if the animation is interrupted

Returns
`Unit`	the reason the reset animation ended

Public properties

dismissDirection

Cmn

Added in 1.0.0

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.