AnimationEndReason

Artifact: androidx.compose.animation:animation-core

View Source

Added in 1.0.0

Common/All

• Cmn

  enum AnimationEndReason : Enum

kotlin.Any
↳	kotlin.Enum
	↳	androidx.compose.animation.core.AnimationEndReason

---

Possible reasons for Animatables to end.

Summary

Enum Values
BoundReached	Animation will be forced to end when its value reaches upper/lower bound (if they have been defined, e.g. via Animatable.updateBounds)
Finished	Animation has finished successfully without any interruption.

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

Public properties
EnumEntries<AnimationEndReason>	entries Returns a representation of an immutable list of all enum entries, in the order they're declared.	Cmn

Enum Values

BoundReached

val AnimationEndReason.BoundReached: AnimationEndReason

Animation will be forced to end when its value reaches upper/lower bound (if they have been defined, e.g. via Animatable.updateBounds)

Unlike Finished, when an animation ends due to BoundReached, it often falls short from its initial target, and the remaining velocity is often non-zero. Both the end value and the remaining velocity can be obtained via AnimationResult.

Finished

val AnimationEndReason.Finished: AnimationEndReason

Animation has finished successfully without any interruption.

Public functions

valueOf

Cmn

Added in 1.0.0

fun valueOf(value: String): AnimationEndReason

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.0.0

fun values(): Array<AnimationEndReason>

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

Cmn

val entries: EnumEntries<AnimationEndReason>

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.