aninest root / AnimatableEvents

AnimatableEvents

Various ways to attach and detach event listeners to an Animation.

Index

Type Aliases

Type alias	Description
AnimatableEvents	The various event types that are emitted by the animation. Here are the possible events: - start: when the animation's target state is changed by calling modifyTo and the new state is different from the current state. Returns a LocalAnimatable of the new local state with only the changed values. - end: when the animation fully comes to a stop, provides the resting state Returns an Animatable of the new local state with the final resting state. - beforeEnd: when the animation is about to end Useful for preventing the animation from ending to instead loop/bounce/snap etc. - interrupt: when a new modifyTo is called before the animation is finished Returns a LocalAnimatable of the new local state with all of the currently in progress values. - update: when the current state of the animation changes, usually from a call to updateAnimation. Returns undefined
AnimatableEventsWithValue	Animation Events which return the values which the animation is interpolating to. Only excludes the update event.
AnimatableListener	Listens to the animation for a specific event. All events aside from update return a dictionary of local values which are currently being animated.

Functions

Function	Description
addLocalListener	Adds a local listener to the animation. You can listen to the events listed in AnimatableEvents. Animation listeners are scoped to only trigger when the current level of the animation is modified. Animation listeners are called in the order in which they were added.
addRecursiveListener	Adds a recursive start listener to the animation. This listener will trigger on any child modification. Animation listeners are called in the order in which they were added.
removeLocalListener	Removes a listener from the animation
removeRecursiveListener	Removes a recursive start listener from the animation