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

DismissValue

@ExperimentalMaterial3Api
public enum DismissValue extends Enum

java.lang.Object
   ↳ kotlin.Enum
     ↳ androidx.compose.material3.DismissValue

Possible values of SwipeToDismissBoxState.

Summary

Enum Values

Default

Indicates the component has not been dismissed yet.

DismissedToEnd

Indicates the component has been dismissed in the reading direction.

DismissedToStart

Indicates the component has been dismissed in the reverse of the reading direction.

Public methods

final @NonNull EnumEntries<@NonNull DismissValue>

Possible values of SwipeToDismissBoxState.

final @NonNull DismissValue

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

final @NonNull DismissValue[]

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

Enum Values

Default

@ExperimentalMaterial3Api
DismissValue DismissValue.Default

Indicates the component has not been dismissed yet.

DismissedToEnd

@ExperimentalMaterial3Api
DismissValue DismissValue.DismissedToEnd

Indicates the component has been dismissed in the reading direction.

DismissedToStart

@ExperimentalMaterial3Api
DismissValue DismissValue.DismissedToStart

Indicates the component has been dismissed in the reverse of the reading direction.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull DismissValuegetEntries()

Possible values of SwipeToDismissBoxState.

valueOf

public final @NonNull DismissValue 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 DismissValue[] 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.