SwipeToDismissKeys
enum SwipeToDismissKeys : Enum
Keys used to persistent state in BasicSwipeToDismissBox.
Summary
Enum Values |
|
|---|---|
Background |
The default background key to identify the content displayed by the content block when isBackground == true. |
Content |
The default content key to identify the content displayed by the content block when isBackground == false. |
Public functions |
|
|---|---|
SwipeToDismissKeys |
Returns the enum constant of this type with the specified name. |
Array<SwipeToDismissKeys> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<SwipeToDismissKeys> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
Enum Values
Background
val SwipeToDismissKeys.Background: SwipeToDismissKeys
The default background key to identify the content displayed by the content block when isBackground == true. Specifying a background key instead of using the default allows remembered state to be correctly moved between background and foreground.
Content
val SwipeToDismissKeys.Content: SwipeToDismissKeys
The default content key to identify the content displayed by the content block when isBackground == false. Specifying a background key instead of using the default allows remembered state to be correctly moved between background and foreground.
Public functions
valueOf
fun valueOf(value: String): SwipeToDismissKeys
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
fun values(): Array<SwipeToDismissKeys>
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<SwipeToDismissKeys>
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.