Animatable
@RememberInComposition
public fun Animatable(
initialValue: Float,
visibilityThreshold: Float = Spring.DefaultDisplacementThreshold,
): Animatable<Float, AnimationVector1D>
This Animatable
function creates a float value holder that automatically animates its value
when the value is changed via animateTo
. Animatable
supports value change during an ongoing
value change animation. When that happens, a new animation will transition Animatable
from its
current value (i.e. value at the point of interruption) to the new target. This ensures that the
value change is always continuous using animateTo
. If spring
animation (i.e. default
animation) is used with animateTo
, the velocity change will be guaranteed to be continuous as
well.
Unlike AnimationState
, Animatable
ensures mutual exclusiveness on its animation. To do so,
when a new animation is started via animateTo
(or animateDecay
), any ongoing animation job
will be cancelled.
Parameters
initialValue | initial value of the animatable value holder |
visibilityThreshold | Threshold at which the animation may round off to its target value. Spring.DefaultDisplacementThreshold by default. |