@angular/animations

useAnimation

function

deprecatedsince v20.2

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

Deprecation warning

Use animate.enter or animate.leave instead. Intent to remove in v23

API

function useAnimation(
  animation: AnimationReferenceMetadata,
  options?: AnimationOptions | null,
): AnimationAnimateRefMetadata;

AnimationAnimateRefMetadata

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

@deprecated

Use animate.enter or animate.leave instead. Intent to remove in v23

@paramanimationAnimationReferenceMetadata

The reusable animation to start.

@paramoptionsAnimationOptions | null

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

@returnsAnimationAnimateRefMetadata