Skip to content

aninest root / AnimatableEvents / AnimatableEvents

AnimatableEvents

ts
type AnimatableEvents: AnimatableEventsWithValue | "update";

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

Defined in

Animate/AnimatableEvents.ts:224