AnimationTrigger

sealed interface AnimationTrigger

Strategy interface that controls when an animation begins receiving frame callbacks.

Inspired by CoroutineStart / SharingStarted, this lets callers decouple animation setup from animation start. In collections with hundreds of items, animations can run to completion while items are still off-screen. AnimationTrigger solves this without per-item state updates.

See also

Inheritors

Types

Link copied to clipboard

Starts the animation immediately. This is the default.

Link copied to clipboard

An AnimationTrigger that defers animation start until start is called explicitly.

Functions

Link copied to clipboard
abstract fun onReady(handle: AnimationHandle): CleanupFunc?

Called when the animation is set up and ready to begin. Call handle.start to begin frame callbacks. Return a CleanupFunc to clean up resources when the animation is cancelled or the component unmounts, or null if not needed.