nativescript-community/ui-lottie

NativeScript plugin to expose Airbnb Lottie for awesome animations.

Changelog

All notable changes to this project will be documented in the changelog.

Demo Screen

The .gif does not do the fluid animations justice

Installation

To install execute:

tns plugin add @nativescript-community/ui-lottie

Usage

NativeScript (Core)

XML

1<Page
2    xmlns="http://schemas.nativescript.org/tns.xsd"
3    xmlns:Lottie="@nativescript-community/ui-lottie" navigatingTo="navigatingTo" class="page">
4    <StackLayout>
5        <Lottie:LottieView src="PinJump.json" height="130" loop="true" autoPlay="true" loaded="yourLoadedEvent" />
6    </StackLayout>
7</Page>

TS

1import { LottieView } from "@nativescript-community/ui-lottie";
2
3public yourLoadedEvent(args) {
4    this._myLottie = args.object as LottieView; /// this is the instance of the LottieAnimationView
5}

---

NativeScript Angular

Module

First you need to include the NativeScriptLottieModule in your app.module.ts

1import { NativeScriptLottieModule} from '@nativescript-community/ui-lottie/angular';
2
3@NgModule({
4    imports: [
5        NativeScriptLottieModule
6    ],
7    ...
8})

XML

1<StackLayout>
2    <LottieView width="100" height="150" [src]="src" [loop]="loop" [autoPlay]="autoPlay" (loaded)="lottieViewLoaded($event)">     </LottieView>
3</StackLayout>

Component

1import { Component } from '@angular/core';
2import { LottieView } from '@nativescript-community/ui-lottie';
3
4@Component({
5  templateUrl: 'home.component.html',
6  moduleId: module.id
7})
8export class HomeComponent {
9  public loop: boolean = true;
10  public src: string;
11  public autoPlay: boolean = true;
12  public animations: Array<string>;
13
14  private _lottieView: LottieView;
15
16  constructor() {
17    this.animations = [
18      'Mobilo/A.json',
19      'Mobilo/D.json',
20      'Mobilo/N.json',
21      'Mobilo/S.json'
22    ];
23    this.src = this.animations[0];
24  }
25
26  lottieViewLoaded(event) {
27    this._lottieView = <LottieView>event.object;
28  }
29}

---

NativeScript Vue

Bootstrap

If you want to use this plugin with Vue, do this in your app.js or main.js:

1import LottieView from '@nativescript-community/ui-lottie/vue';
2
3Vue.use(LottieView);

This will install and register LottieView component to your Vue instance and now you can use the plugin.

Component

1<template>
2    <Page class="page">
3        <StackLayout>
4            <LottieView height="130" src="PinJump.json" :loop="true" :autoPlay="true" @loaded="lottieViewLoaded"></LottieView>
5        </StackLayout>
6    </page
7</template>
8
9<script>
10    export default {
11        methods: {
12            lottieViewLoaded(args) {
13                this._lottieView = args.object;
14            },
15        },
16        data() {
17            return {
18                _lottieView: null,
19            }
20        }
21    };
22</script>

---

Assets

:fire: You can find animations in the sample-effects folder.

Android

Place your animation files in the NS app's app/App_Resources/Android/src/main/assets folder.

Note: In a nativescript-vue project the above folder may not exist. Place the files in platforms/android/app/src/main/assets.

iOS

Place your animations files in your app/App_Resources/iOS/ folder.

Properties (bindable)

Property	Type	Default	Description
autoPlay	boolean	false	Start LottieView animation on load if true.
loop	boolean	false	Loop continuously animation if true.
src	string	null	Animation path to .json file.

Properties

Property	Type	Default	Description
completionBlock	(boolean) => void	null	Completion block to be executed upon completion of the animation. The animation is considered complete when it finishes playing and is no longer looping.
duration	number	null	Get the duration of the animation.
progress	number	0	Get/set the progress of the animation.
speed	number	1	Get/set the speed of the animation.

Methods

Method	Return	Parameters	Description
cancelAnimation	void	None	Pauses the animation for the LottieView instance.
isAnimating	boolean	None	Returns true if the LottieView is animating, else false.
playAnimation	void	None	Plays the animation for the LottieView instance.
playAnimationFromProgressToProgress	void	startProgress, endProgress	Plays the animation for the LottieView instance from the specified start and end progress values (between 0 and 1).
setColor	void	value, keyPath	Sets the provided color value on each property that matches the specified keyPath in the LottieView instance.
setOpacity	void	value, keyPath	Sets the provided opacity value (0 - 1) on each property that matches the specified keyPath in the LottieView instance.

Contributors

bradmartin	NathanWalker	rhanb	HamdiWanis

itstheceo	mudlabs