{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

SwipeToDismissBoxValue

@ExperimentalMaterial3Api
public enum SwipeToDismissBoxValue extends Enum

java.lang.Object
   ↳ 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 methods

final @NonNull EnumEntries<@NonNull SwipeToDismissBoxValue>

The directions in which a SwipeToDismissBox can be dismissed.

final @NonNull SwipeToDismissBoxValue

Returns the enum constant of this type with the specified name.

final @NonNull SwipeToDismissBoxValue[]

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

Enum Values

EndToStart

@ExperimentalMaterial3Api
SwipeToDismissBoxValue SwipeToDismissBoxValue.EndToStart

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

Settled

@ExperimentalMaterial3Api
SwipeToDismissBoxValue SwipeToDismissBoxValue.Settled

Cannot currently be dismissed.

StartToEnd

@ExperimentalMaterial3Api
SwipeToDismissBoxValue SwipeToDismissBoxValue.StartToEnd

Can be dismissed by swiping in the reading direction.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull SwipeToDismissBoxValuegetEntries()

The directions in which a SwipeToDismissBox can be dismissed.

valueOf

public final @NonNull SwipeToDismissBoxValue valueOf(@NonNull String value)

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

public final @NonNull SwipeToDismissBoxValue[] values()

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.