Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OutSystems/cordova-plugin-lottie-splashscreen
https://github.com/OutSystems/cordova-plugin-lottie-splashscreen
odc snyk-forge-components ssdlc-rules
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/OutSystems/cordova-plugin-lottie-splashscreen
- Owner: OutSystems
- License: mit
- Created: 2023-05-15T16:28:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T09:15:00.000Z (6 months ago)
- Last Synced: 2024-11-08T00:59:13.114Z (3 months ago)
- Topics: odc, snyk-forge-components, ssdlc-rules
- Language: Kotlin
- Size: 9.78 MB
- Stars: 1
- Watchers: 18
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# cordova-plugin-lottie-splashscreen
[](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3A%22Run+a+security+audit%22)
[](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3ALinting)
[](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions/workflows/smoke-test-ubuntu.yml)
[](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions/workflows/smoke-test-ubuntu-ionic.yml)
[](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3A%22Smoke+test+on+macOS%22)
[](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3A%22Smoke+test+on+Windows%22)
[](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/network/dependencies)
[](https://snyk.io/test/github/timbru31/cordova-plugin-lottie-splashscreen)
[](https://commitizen.github.io/cz-cli/)
[](LICENSE)
[](https://www.npmjs.com/package/cordova-plugin-lottie-splashscreen)
#### Apache Cordova plugin to show bodymovin/Lottie animations as the splash screen with [Airbnb's Lottie](https://airbnb.io/lottie/) wrapper
### Supported platforms
- **iOS (11+) (with cordova-ios >= 5.0.0 only)**
- **Android (with cordova-android >= 10.0.0 only)**
### Planned platforms
- **macOS** (currently on hold until cordova-osx has a better Swift and CocoaPods support or cordova-ios gains Catalyst support)
#### Prerequisites/Warnings
#### iOS
You need to have [CocoaPods](https://cocoapods.org/) installed because [lottie-ios](https://cocoapods.org/pods/lottie-ios) is fetched from there.
```sh
$ sudo gem install cocoapods
$ pod setup
```
##### Caveats
Only **cordova >= 9.0.0** and **cordova-ios >= 5.0.0** are supported.
You need to specify a valid `SwiftVersion` (minimum is 5.5) in your `config.xml`. (see https://cordova.apache.org/docs/en/latest/config_ref/)
#### Android
AndroidX and Kotlin support is required. Therefore only **cordova-android >= 9.0.0** is supported.
If you use `cordova-android` <10.0.0 then you need to enable Kotlin and AndroidX in your `config.xml` by setting `GradlePluginKotlinEnabled` **and** `AndroidXEnabled` to `true`.
In the [FAQ](FAQ.md) are some examples with common error messages and how to fix them.
### Installation
#### from npm (recommended)
`$ cordova plugin add cordova-plugin-lottie-splashscreen`
#### from git (unstable)
`$ cordova plugin add https://github.com/timbru31/cordova-plugin-lottie-splashscreen.git`
### Usage
This Apache Cordova plugin is meant as a replacement for the stock [cordova-plugin-splashscreen](https://github.com/apache/cordova-plugin-splashscreen).
An example project can be found in the `example` folder.
#### Methods
- lottie.splashscreen.hide
- lottie.splashscreen.show
- lottie.splashscreen.on
- lottie.splashscreen.once
##### lottie.splashscreen.hide
This methods hides the current active Lottie splashscreen and destroys the views. Returns a Promise which is resolved with "OK" in the success case or the error message when it's failed.
```js
await lottie.splashscreen.hide();
```
##### lottie.splashscreen.show
This method 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. Returns a Promise which is resolved with "OK" in the success case or the error message when it's failed. (For easier reading the TypeScript notation is used)
```ts
await lottie.splashscreen.show(location?: string, remote?: boolean, width?: number, height?: number)
```
##### lottie.splashscreen.on
This method listens to custom lottie events that are dispatched from the native side and invokes a configured callback function. If the `event` parameter is a falsy value, such as `null` or `""`, the method will listen to all Lottie events. (For easier reading the TypeScript notation is used)
```ts
type LottieEvent = 'lottieAnimationStart' | 'lottieAnimationEnd' | 'lottieAnimationCancel' | 'lottieAnimationRepeat';
lottie.splashscreen.on(event: LottieEvent, callback: (ev: Event) => void);
```
##### lottie.splashscreen.once
This method listens to a custom lottie event once and resolves the Promise once the event has been called. (For easier reading the TypeScript notation is used)
```ts
type LottieEvent = 'lottieAnimationStart' | 'lottieAnimationEnd' | 'lottieAnimationCancel' | 'lottieAnimationRepeat';
await lottie.splashscreen.once(event: LottieEvent).then(event => console.log(event));
```
### Preferences
- `LottieRemoteEnabled` (Boolean, default `false`). Toggles Lottie's remote mode which allows files to be downloaded/displayed from URLs. Example:
```xml
```
- `LottieAnimationLocationLight` (String, default `""`). Location of the Lottie JSON file that should be loaded in light mode. Can either be a URL (if `LottieRemoteEnabled` is `true`) or a local JSON or ZIP file (e.g. `www/lottie/error.json`).
```xml
```
- `LottieAnimationLocationDark` (String, default `""`). Location of the Lottie JSON file that should be loaded in dark mode. Can either be a URL (if `LottieRemoteEnabled` is `true`) or a local JSON or ZIP file (e.g. `www/lottie/error.json`).
```xml
```
- `LottieAnimationLocation` (String, default `""`). Location of the Lottie JSON file that should be loaded as a fallback if there are no dark or light mode animations defined or if one of them is an invalid location. Can either be a URL (if `LottieRemoteEnabled` is `true`) or a local JSON or ZIP file (e.g. `www/lottie/error.json`).
```xml
```
- `LottieImagesLocation` (String, default `path of LottieAnimationLocation`). **Android only!** Location of the Lottie images folder specified by the JSON.
```xml
```
- `LottieCancelOnTap` (Boolean, default `false`). Immediately cancels the Lottie animation when the user taps on the screen.
```xml
```
- `LottieHideTimeout` (Double for iOS and Integer for Android, default `0`). Duration after which the Lottie animation should be hidden. **CAUTION:** iOS reads this value in **SECONDS**, but e.g., `0.5` is supported. Android reads this value in **MILLISECONDS**!
```xml