Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngx-lottie/ngx-lottie
Fully customizable Angular component for rendering After Effects animations. Compatible with Angular 9+ :rocket:
https://github.com/ngx-lottie/ngx-lottie
Last synced: 2 months ago
JSON representation
Fully customizable Angular component for rendering After Effects animations. Compatible with Angular 9+ :rocket:
- Host: GitHub
- URL: https://github.com/ngx-lottie/ngx-lottie
- Owner: ngx-lottie
- License: mit
- Created: 2019-03-03T22:24:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-11T13:58:15.000Z (7 months ago)
- Last Synced: 2024-11-11T17:49:53.016Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.59 MB
- Stars: 225
- Watchers: 9
- Forks: 38
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - ngx-lottie - Fully customizable Angular component for rendering After Effects animations. Compatible with Angular 9+. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-lottie - Fully customizable Angular component for rendering After Effects animations. Compatible with Angular 9+. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-lottie - Fully customizable Angular component for rendering After Effects animations. Compatible with Angular 9+. (Table of contents / Third Party Components)
README
A minimal customizable performance-stable Angular component for rendering After Effects animations. Compatible with Angular 9+.
## Compatibility with Angular Versions
ngx-lottie
Angular
7.x
>= 8 < 13
8.x
13
9.x
14
10.x
15
11.x
17
12.x
18
## Table of contents
- [Features](#features)
- [Quick example](#quick-example)
- [Installation](#installation)
- [Usage](#usage)
- [Updating animation](#updating-animation)
- [Listening to lottie-web events](#listening-to-lottie-web-events)
- [Caching](#caching)
- [API](#api)
- [Reducing lottie-web bundle size](#reducing-lottie-web-bundle-size)
- [Optimizations](#optimizations)
- [Server side rendering](#server-side-rendering)
- [Potential pitfalls](#potential-pitfalls)
## Features
- **rich:** `ngx-lottie` provides more opportunities to work with API exposed by Lottie
- **strict:** all types of objects and events are available to you
- **performant:** the `lottie-web` library can be loaded synchronously or on-demand
## Quick example
```html
```
## Installation
To install `ngx-lottie`, run the following command:
```bash
npm i lottie-web ngx-lottie
# Or if you use yarn
yarn add lottie-web ngx-lottie
# Or if you use pnpm
pnpm i lottie-web ngx-lottie
```
> Please note: ngx-lottie uses [Scarf](https://scarf.sh/) to collect anonymized installation analytics. These analytics help support the maintainers of this library. However, if you'd like to opt out, you can do so by setting `scarfSettings.enabled = false` in your project's package.json. Alternatively, you can set the environment variable `SCARF_ANALYTICS=false` before you install.
## Usage
First, add `provideLottieOptions` to the `app.config.ts`:
```typescript
// src/app/app.config.ts
import { provideLottieOptions } from 'ngx-lottie';
import player from 'lottie-web';
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => player,
}),
],
};
```
The `lottie-web` library can be loaded on demand using dynamic import. Webpack will load this library only when your animation gets rendered for the first time. Given the following code:
```ts
// src/app/app.config.ts
import { provideLottieOptions } from 'ngx-lottie';
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => import('lottie-web'),
}),
],
};
```
Now you can use the `ng-lottie` component and provide your custom options via the `options` binding.
```typescript
import { Component } from '@angular/core';
import { AnimationItem } from 'lottie-web';
import { LottieComponent, AnimationOptions } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: ` `,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
animationCreated(animationItem: AnimationItem): void {
console.log(animationItem);
}
}
```
Also, it's possible to use the `lottie` directive if you'd like to provide your custom container and manage it:
```typescript
import { Component } from '@angular/core';
import { AnimationItem } from 'lottie-web';
import { LottieDirective, AnimationOptions } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: `
`,
standalone: true,
imports: [LottieDirective],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
animationCreated(animationItem: AnimationItem): void {
console.log(animationItem);
}
}
```
## Updating animation
If you want to update the animation dynamically then you have to update the animation options immutably. Let's look at the following example:
```ts
import { Component } from '@angular/core';
import { AnimationItem } from 'lottie-web';
import { LottieComponent, AnimationOptions } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: `
Update animation
`,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
animationCreated(animationItem: AnimationItem): void {
console.log(animationItem);
}
updateAnimation(): void {
// ⚠️⚠️ Don't do this!
this.options.path = '/assets/new-animation.json';
// ✔️✔️ Update `options` in this way
this.options = {
...this.options, // In case you have other properties that you want to copy
path: '/assets/new-animation.json',
};
}
}
```
If you want to update options relying on a response from the server, then you'll have to call `detectChanges` manually to ensure the change detection is run if `ng-lottie` is inside a `ChangeDetectionStrategy.OnPush` component:
```ts
import { Component, ChangeDetectionStrategy, ChangeDetectorRef } from '@angular/core';
import { AnimationItem } from 'lottie-web';
import { LottieComponent, AnimationOptions } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: `
Update animation
`,
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
constructor(
private ref: ChangeDetectorRef,
private animationService: AnimationService,
) {}
animationCreated(animationItem: AnimationItem): void {
console.log(animationItem);
}
updateAnimation(): void {
this.animationService.loadAnimationOptions().subscribe(options => {
this.options = options;
this.ref.detectChanges();
});
}
}
```
You can also store options in `signal` and bind them via the `options()` signal call:
```ts
@Component({
selector: 'app-root',
template: `
Update animation
`,
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options = signal({
path: '/assets/animation.json',
});
constructor(
private ref: ChangeDetectorRef,
private animationService: AnimationService,
) {}
animationCreated(animationItem: AnimationItem): void {
console.log(animationItem);
}
updateAnimation(): void {
this.animationService.loadAnimationOptions().subscribe(options => {
this.options.set(options);
});
}
}
```
## Listening to `lottie-web` events
The `ng-lottie` adds event listeners to those events that are listened outside. This means that if you've got the following code:
```html
```
In the above example, the `ng-lottie` will only listen to the `loopComplete` event on the `AnimationItem` under the hood. One important note that all events are handled outside of the Angular zone:
```ts
ngZone.runOutsideAngular(() => {
animationItem.addEventListener('loopComplete', () => {});
});
```
I made such a design decision because animation items can emit hundreds and thousands of events every second. The `lottie-web` emits some events asynchronously by wrapping them into `setTimeout` internally. Suppose thousands of events occur during a single second. In that case, Angular will run change detection a thousand times, drastically decreasing performance.
Therefore, event handlers will be called outside of the Angular zone:
```ts
import { Component, ChangeDetectionStrategy, NgZone } from '@angular/core';
import { LottieComponent, AnimationOptions } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: ` `,
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
onLoopComplete(): void {
NgZone.assertNotInAngularZone();
console.log(NgZone.isInAngularZone()); // false
}
}
```
Therefore you need to re-enter the Angular execution context and call change detection manually via `ChangeDetectorRef.detectChanges()`:
```ts
import { Component, ChangeDetectionStrategy, NgZone, ChangeDetectorRef } from '@angular/core';
import { LottieComponent, AnimationOptions } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: `
On loop complete called times = {{ onLoopCompleteCalledTimes }}
`,
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
onLoopCompleteCalledTimes = 0;
constructor(
private ngZone: NgZone,
private ref: ChangeDetectorRef,
) {}
onLoopComplete(): void {
this.ngZone.run(() => {
this.onLoopCompleteCalledTimes++;
this.ref.detectChanges();
});
}
}
```
## Caching
The `lottie-web` will load your JSON file whenever animation is created. When providing options in the root config, you can also add the `provideCacheableAnimationLoader`:
```ts
// src/app/app.config.ts
import { provideLottieOptions, provideCacheableAnimationLoader } from 'ngx-lottie';
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => player,
}),
provideCacheableAnimationLoader(),
],
};
```
This will enable the internal cache. The `ngx-lottie` will load JSON files only once since the cache is enabled.
## API
### Bindings
The `ng-lottie` component supports the following bindings:
```ts
@Component({
selector: 'app-root',
template: `
`,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
styles: Partial = {
maxWidth: '500px',
margin: '0 auto',
};
}
```
- `options: AnimationOptions` options used by `AnimationItem`
- `width?: string` container element width in pixels. Bound to `[style.width]`. You can provide any CSS unit, e.g. `100em`
- `height?: string` container element height in pixels. Bound to `[style.height]`. You can provide any CSS unit, e.g. `100em`
- `styles?: Partial` custom styles object. Bound to `[ngStyle]`
- `containerClass?: string` custom container class(es). Bound to `[ngClass]`.
The `lottie` directive supports only `options` binding.
### Events
| @Output() | Type | Required | Description |
| ---------------- | ----------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| animationCreated | `AnimationItem` | optional | Dispatched after the `lottie` successfully creates animation |
| configReady | `void` | optional | Dispatched after the needed renderer is configured |
| dataReady | `void` | optional | Dispatched when all parts of the animation have been loaded |
| domLoaded | `void` | optional | Dispatched when elements have been added to the DOM |
| enterFrame | `BMEnterFrameEvent` | optional | Dispatched after entering the new frame |
| segmentStart | `BMSegmentStartEvent` | optional | Dispatched when the new segment is adjusted |
| loopComplete | `BMCompleteLoopEvent` | optional | Dispatched after completing frame loop |
| complete | `BMCompleteEvent` | optional | Dispatched after completing the last frame |
| destroy | `BMDestroyEvent` | optional | Dispatched in the `ngOnDestroy` hook of the service that manages `lottie`'s events, it's useful for releasing resources |
| error | `BMRenderFrameErrorEvent OR BMConfigErrorEvent` | optional | Dispatched if the lottie player could not render some frame or parse the config |
## Reducing `lottie-web` bundle size
The size of the `lottie-web` library is quite large. Because when we write this:
```ts
import player from 'lottie-web';
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => player,
}),
],
};
// Or if you load `lottie-web` on demand
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => import('lottie-web'),
}),
],
};
```
It bundles all 3 renderers: `CanvasRenderer`, `SVGRenderer` and `HybridRenderer`. The `SVGRenderer` is used by default. If you don't care which renderer is used and never provide the `renderer` option, you might want to exclude `CanvasRenderer` and `HybridRenderer`. To do this, just import the `lottie_svg` file that is inside the `lottie-web/build/player` folder:
```ts
import player from 'lottie-web/build/player/lottie_svg';
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => player,
}),
],
};
// Or if you load `lottie-web` on demand
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => import('lottie-web'),
}),
],
};
```
Its minified size is `198 KiB`.
You can also use the `lottie-web` light version. As Hernan Torrisi (author of `lottie-web`) explains:
> It should work fine, but animations won't render correctly if they have expressions or effects.
The light version can be imported using the following code:
```ts
import player from 'lottie-web/build/player/lottie_light';
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => player,
}),
],
};
// Or if you load `lottie-web` on demand
export const appConfig: ApplicationConfig = {
providers: [
provideLottieOptions({
player: () => import('lottie-web/build/player/lottie_light'),
}),
],
};
```
Its minified size is `148 KiB`. Use this at your own risk because I can't know if your animations contain expressions or effects.
## Optimizations
The `ng-lottie` component is marked with the `OnPush` change detection strategy. This means Angular will not check it in any phase of the change detection mechanism until you change the reference to some binding. For example, if you use an `svg` renderer and there are a lot of DOM elements projected — you would like to avoid checking this component, as it's not necessary.
The `ngx-lottie` listens to `AnimationItem` events outside of the Angular zone. It would be best if you didn't worry that animation events will cause change detection every ms.
**But be careful!** Always wrap any calls to `AnimationItem` methods in `runOutsideAngular`. See the below code:
```ts
import { Component, NgZone } from '@angular/core';
import { AnimationItem } from 'lottie-web';
import { LottieComponent, AnimationOptions } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: `
Stop
Play
`,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
path: '/assets/animation.json',
};
private animationItem: AnimationItem;
constructor(private ngZone: NgZone) {}
animationCreated(animationItem: AnimationItem): void {
this.animationItem = animationItem;
}
stop(): void {
this.ngZone.runOutsideAngular(() => {
this.animationItem.stop();
});
}
play(): void {
this.ngZone.runOutsideAngular(() => {
this.animationItem.play();
});
}
}
```
## Server-side rendering
By default, `lottie-web` will load your JSON file with animation data every time you create an animation. You may have some problems with the connection, so there may be some delay or even timeout. It's worth loading animation data only once and cache it on the client-side, so every time you create an animation — `ngx-lottie` will retrieve the animation data from the cache.
The `ngx-lottie/server` package allows you to preload animation data and cache it using `TransferState`.
### How2?
TL;DR - see the `integration` folder.
Add the `provideLottieServerOptions` into your `appServerConfig`:
```typescript
// src/app/app.config.server.ts
import { mergeApplicationConfig } from '@angular/core';
import { provideServerRendering } from '@angular/platform-server';
import { provideLottieServerOptions } from 'ngx-lottie/server';
import { appConfig } from './app.config';
export const appServerConfig = mergeApplicationConfig(appConfig, {
providers: [
provideServerRendering(),
provideLottieServerOptions({
preloadAnimations: {
folder: 'dist/browser/assets',
animations: ['data.json'],
},
}),
],
});
```
Let's look at these options. `animations` is an array of JSON files that contain animation data that Node.js should read on the server-side, cache, and transfer to the client. `folder` is a path where your JSON files are located. Still, you should use it properly. This path is joined with the `process.cwd()`. Consider the following project structure:
```
— dist (here you store your output artifacts)
— browser
— assets
— index.html
— main.hash.js
- server
- main.js
— src (here is your app)
— angular.json
— package.json
```
If you start a server from the root folder like `node dist/server/main`, thus the `folder` property should equal `dist/browser/assets`.
You can now inject the `LottieTransferState` into your components from the `ngx-lottie` package. It's tree-shakable by default and won't get bundled until you inject it anywhere:
```typescript
import { Component } from '@angular/core';
import { LottieComponent, AnimationOptions, LottieTransferState } from 'ngx-lottie';
@Component({
selector: 'app-root',
template: ` `,
standalone: true,
imports: [LottieComponent],
})
export class AppComponent {
options: AnimationOptions = {
animationData: this.lottieTransferState.get('data.json'),
};
constructor(private lottieTransferState: LottieTransferState) {}
}
```
Notice, `data.json` is a filename that you pass to the `preloadAnimations.animations` property.
## Potential pitfalls
There is only one potential pitfall associated with animations in the Safari browser. Also, this known issue is in the `lottie-web` library itself. Library consumers have been trying to resolve that issue using different solutions. The only solution that helped most people was installing the latest version of the `lottie-web`.