This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.

useAnimation

Starts a reusable animation that is created using the animation() function.

      
      useAnimation(animation: AnimationReferenceMetadata, options: AnimationOptions | null = null): AnimationAnimateRefMetadata
    

Parameters

animation

The reusable animation to start.

options

An options object that can contain a delay value for the start of the animation, and additional override values for developer-defined parameters.

Optional. Default is null.

Returns

AnimationAnimateRefMetadata: An object that contains the animation parameters.