SwipeToDismissBoxValue

Artifact: androidx.compose.material3:material3

View Source

Added in 1.2.0

Common/AllAndroid/JVM

• Cmn

  enum SwipeToDismissBoxValue : Enum

kotlin.Any
↳	kotlin.Enum
	↳	androidx.compose.material3.SwipeToDismissBoxValue

---

The directions in which a SwipeToDismissBox can be dismissed.

Summary

Enum Values
EndToStart	Can be dismissed by swiping in the reverse of the reading direction.
Settled	Cannot currently be dismissed.
StartToEnd	Can be dismissed by swiping in the reading direction.

Public functions
SwipeToDismissBoxValue	valueOf(value: String) Returns the enum constant of this type with the specified name.	Cmn
Array<SwipeToDismissBoxValue>	values() Returns an array containing the constants of this enum type, in the order they're declared.	Cmn

Public properties
EnumEntries<SwipeToDismissBoxValue>	entries Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.	Cmn

Enum Values

EndToStart

val SwipeToDismissBoxValue.EndToStart: SwipeToDismissBoxValue

Can be dismissed by swiping in the reverse of the reading direction.

Settled

val SwipeToDismissBoxValue.Settled: SwipeToDismissBoxValue

Cannot currently be dismissed.

StartToEnd

val SwipeToDismissBoxValue.StartToEnd: SwipeToDismissBoxValue

Can be dismissed by swiping in the reading direction.

Public functions

valueOf

Cmn

Added in 1.2.0

fun valueOf(value: String): SwipeToDismissBoxValue

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

Cmn

Added in 1.2.0

fun values(): Array<SwipeToDismissBoxValue>

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.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using entries property as a more efficient alternative returning an immutable list of enum entries.

Public properties

entries

Cmn

val entries: EnumEntries<SwipeToDismissBoxValue>

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.