Skip to content

Commit

Permalink
feat(lottie-splash-screen): add new plugin (#2880)
Browse files Browse the repository at this point in the history
* feat(lottie-splash-screen): added new plugin

* Update index.ts
  • Loading branch information
Nicolas Naso authored and danielsogl committed Jan 19, 2019
1 parent 3226f76 commit 603d694
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions src/@ionic-native/plugins/lottie-splash-screen/index.ts
@@ -0,0 +1,53 @@
import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';

/**
* @name Lottie Splash Screen
* @description
* Cordova plugin to show bodymovin/Lottie animations as the splash screen with Airbnb's Lottie wrapper
*
* @usage
* ```typescript
* import { LottieSplashScreen } from '@ionic-native/lottie-splash-screen';
*
*
* constructor(private lottieSplashScreen: LottieSplashScreen) { }
*
* ...
*
*
* this.lottieSplashScreen.show('www/lottie/animation.json', false, 1024, 768)
* .then((res: any) => console.log(res))
* .catch((error: any) => console.error(error));
*
* ```
*/
@Plugin({
pluginName: 'LottieSplashScreen',
plugin: 'cordova-plugin-lottie-splashscreen',
pluginRef: 'lottie.splashscreen',
repo: 'https://github.com/timbru31/cordova-plugin-lottie-splashscreen',
install: '',
installVariables: [],
platforms: ['Android', 'iOS']
})
@Injectable()
export class LottieSplashScreen extends IonicNativePlugin {
/**
* This function shows a Lottie splash screen. If no arguments are given, it defaults to the config.xml values, however you can pass (new) options here to change the behavior on runtime. (For easier reading the TypeScript notation is used)
* @param location {string} Location of the Lottie JSON file that should be loaded.
* @param remote {number} Toggles Lottie's remote mode which allows files to be downloaded/displayed from URLs. Example:
* @param width {number} Width of the container that's rendering the Lottie animation
* @param height {number} Height of the container that's rendering the Lottie animation
*/
@Cordova({
sync: true
})
show(location?: string, remote?: boolean, width?: number, height?: number): void {}

/**
* This methods hides the current active Lottie splashscreen and destroys the views.
*/
@Cordova({ sync: true })
hide(): void {}
}

0 comments on commit 603d694

Please sign in to comment.