SwipeToDismissValue

enum SwipeToDismissValue : Enum

kotlin.Any
   ↳ kotlin.Enum
     ↳ androidx.wear.compose.foundation.SwipeToDismissValue

States used as targets for the anchor points for swipe-to-dismiss.

Summary

Enum Values
Default

The state of the SwipeToDismissBox before the swipe started.
Dismissed

The state of the SwipeToDismissBox after the swipe passes the swipe-to-dismiss threshold.

Public functions
SwipeToDismissValue
valueOf(value: String)

Returns the enum constant of this type with the specified name.
Array<SwipeToDismissValue>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties
EnumEntries<SwipeToDismissValue>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Enum Values

Default

val SwipeToDismissValue.Default: SwipeToDismissValue

The state of the SwipeToDismissBox before the swipe started.

Dismissed

val SwipeToDismissValue.Dismissed: SwipeToDismissValue

The state of the SwipeToDismissBox after the swipe passes the swipe-to-dismiss threshold.

Public functions

valueOf

Added in 1.4.0-alpha07
fun valueOf(value: String): SwipeToDismissValue

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

Added in 1.4.0-alpha07
fun values(): Array<SwipeToDismissValue>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

Public properties

entries

val entries: EnumEntries<SwipeToDismissValue>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.