Angular-Animations Utility Library

Easy, Reusable Animation Utility library for Angular Apps.

Angular Animations utility library is a collection of reusable and parametrized animations build for Angular 15+ that can be used in a declarative manner. It implements all animations from animate.css (and more). Works both with AOT and JIT compilations.

Quick links

Demo | StackBlitz Demo | StackBlitz Base Template

Table of Contents

• Getting Started
  • Prerequisites
• Installation
• Usage
  • Animations on enter / on leave
  • Animations with state or triggered by state changes
  • Parametrized animations
  • Animation Callbacks
    • Loop animation
    • Chain animations
• Available Animations and Parameters
• Running Demo App
• Authors
• License

Getting Started

Prerequisites

Make sure you import BrowserAnimationModule in your angular app.

 npm i @angular/animations@latest --save

Import BrowserAnimationsModule from @angular/platform-browser/animations in your root NgModule

import { BrowserAnimationsModule } from '@angular/platform-browser/animations';

@NgModule({
  declarations: [
    ...
  ],
  imports: [
    ...
    BrowserAnimationsModule
  ],
})
export class AppModule { }

Installation

 npm i angular-animations --save

Usage

Animations on enter / on leave

Animations on enter / on leave are triggered in a moment when element is added to or removed from the dom. Basic example would be with *ngIf template directive.

Import animation functions that you want to use and add them to animations in a component decorator:

import { fadeInOnEnterAnimation, fadeOutOnLeaveAnimation } from 'angular-animations';

@Component({
  selector: '...',
  templateUrl: '...',
  styleUrls: ['...'],
  animations: [
    fadeInOnEnterAnimation(),
    fadeOutOnLeaveAnimation()
  ]
})

and use them in the template:

<div *ngIf="CONDITION" [@fadeInOnEnter] [@fadeOutOnLeave]></div>

Animations with state or triggered by state changes

These animations take as an input a boolean value. Some animations, like Attention Seekers are triggered depending on the direction parameter; bidirectional (<=>) will be triggered by any state change, unidirectional (=>) will be triggered only when state changes from false to true.

All in and out animations are triggered by changes of state from false to true. Animations that preserve state, like collapse or rotate display default state when the value is false and transition to end state when the value is true

import { collapseAnimation, rubberBandAnimation } from 'angular-animations';

@Component({
  ...
  animations: [
    rubberBandAnimation(),
    collapseAnimation(),
  ]
})

<div [@rubberBand]="rubberState"></div>
<div [@collapse]="collapseState"></div>

Parametrized animations

All animations are open for customizations. All of them have parameters: duration and delay, and if it make sense for an animation, additional ones: translate, degrees or scale.

Parameters can be used either in a component decorator or dynamically in a template.

In a decorator:

@Component({
  ...
  animations: [
    fadeInUpOnEnterAnimation({ anchor: 'enter', duration: 1000, delay: 100, translate: '30px' }),
    bounceOutDownOnLeaveAnimation({ anchor: 'leave', duration: 500, delay: 200, translate: '40px' })
  ]
})

<div *ngIf="CONDITION" [@enter] [@leave]></div>

Animations like Attention Seekers can take a direction parameter (cannot be in template)

@Component({
  ...
  animations: [
    // triggers when STATE changes from false to true
    rubberBandAnimation({anchor: 'rubber', direction: '=>', duration: 500})
  ]
})

<div [@rubber]="STATE"></div>

In a template (providing option for dynamic changes):

@Component({
  ...
  animations: [
    fadeInUpOnEnterAnimation({ anchor: 'enter'),
  ]
})

<div *ngIf="CONDITION" [@enter]="{ value: '', params: { duration: 300, delay: 0, translate: '30px' } }" [@leave]></div>
<div *ngIf="CONDITION" [@enter]="{ value: '', params: { duration: 300, delay: 100, translate: '40px } }" [@leave]></div>

With parameters in a template, we can for example achieve staggering animations:

<div *ngFor="let i of [1,2,3]" [@enter]="{ value: '', params: { delay: i * 100 } }"></div>

Animation Callbacks

Each animation supports start and done callbacks to setup hook methods that get called at the start or end of animations. We can add callbacks with the syntax (@trigger.start) or (@trigger.done), where trigger is the name of the animation trigger/anchor being used.

<div [@fadeIn]="animationState" (@fadeIn.start)="animStart($event)" (@fadeIn.done)="animDone($event)"></div>

The callbacks receive an AnimationEvent that contains the following properties: fromState phaseName("start" or "done"), toState and totalTime

import { AnimationEvent } from '@angular/animations';

//...

animStart(event: AnimationEvent) {
  console.log('Animation Started', event);
}

animDone(event: AnimationEvent) {
  console.log('Animation Ended', event);
}

You can find more information about Animation callbacks in the Angular docs

Loop animation

You can achieve looped animation by using done callback. Define a variable that triggers animation and toggle it when animation done callback is called:

<div [@bounce]="animState" (@bounce.done)="animDone()"></div>

and in the component:

  animState = false;

  animDone() {
    this.animState = !this.animState
  }

Example: simple infinite loop animation
Example: repeat animation N times after clicking the button
Example: repeat animation until certain event occurs

Chain animations

You can chain animations (e.g. wait for the first animation to finish before the second one starts) by using the done callback. Example: OnEnter/OnLeave chained animations

Available Animations and Parameters

All animations have duration and delay params.

Running Demo App

npm install
npm start

Authors

• Chris Filipowski - filipows

License

This project is licensed under the MIT License - see the LICENSE file for details