{"id":13992222,"url":"https://github.com/OutSystems/cordova-plugin-lottie-splashscreen","last_synced_at":"2025-07-22T15:31:33.029Z","repository":{"id":184904332,"uuid":"641033790","full_name":"OutSystems/cordova-plugin-lottie-splashscreen","owner":"OutSystems","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-28T14:20:46.000Z","size":10428,"stargazers_count":1,"open_issues_count":11,"forks_count":0,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-06-28T15:32:04.912Z","etag":null,"topics":["odc","snyk-vanguard","ssdlc-rules"],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OutSystems.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["timbru31"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"custom":"https://paypal.me/timbru/"}},"created_at":"2023-05-15T16:28:37.000Z","updated_at":"2025-04-03T11:59:31.000Z","dependencies_parsed_at":"2025-06-18T09:51:09.879Z","dependency_job_id":null,"html_url":"https://github.com/OutSystems/cordova-plugin-lottie-splashscreen","commit_stats":null,"previous_names":["outsystems/cordova-plugin-lottie-splashscreen"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/OutSystems/cordova-plugin-lottie-splashscreen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-lottie-splashscreen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-lottie-splashscreen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-lottie-splashscreen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-lottie-splashscreen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OutSystems","download_url":"https://codeload.github.com/OutSystems/cordova-plugin-lottie-splashscreen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-lottie-splashscreen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266520694,"owners_count":23942320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["odc","snyk-vanguard","ssdlc-rules"],"created_at":"2024-08-09T14:01:53.144Z","updated_at":"2025-07-22T15:31:28.015Z","avatar_url":"https://github.com/OutSystems.png","language":"Kotlin","funding_links":["https://github.com/sponsors/timbru31","https://paypal.me/timbru/"],"categories":["Kotlin"],"sub_categories":[],"readme":"# cordova-plugin-lottie-splashscreen\n\n[![Run a security audit](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/workflows/Run%20a%20security%20audit/badge.svg)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3A%22Run+a+security+audit%22)\n[![Linting](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/workflows/Linting/badge.svg)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3ALinting)\n[![Smoke test on Ubuntu (Apache Cordova)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions/workflows/smoke-test-ubuntu.yml/badge.svg)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions/workflows/smoke-test-ubuntu.yml)\n[![Smoke test on Ubuntu (Ionic)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions/workflows/smoke-test-ubuntu-ionic.yml/badge.svg)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions/workflows/smoke-test-ubuntu-ionic.yml)\n[![Smoke test on macOS](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/workflows/Smoke%20test%20on%20macOS/badge.svg)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3A%22Smoke+test+on+macOS%22)\n[![Smoke test on Windows](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/workflows/Smoke%20test%20on%20Windows/badge.svg)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/actions?query=workflow%3A%22Smoke+test+on+Windows%22)\n\n[![dependency Status](https://img.shields.io/librariesio/release/npm/cordova-plugin-lottie-splashscreen)](https://github.com/timbru31/cordova-plugin-lottie-splashscreen/network/dependencies)\n[![Known Vulnerabilities](https://snyk.io/test/github/timbru31/cordova-plugin-lottie-splashscreen/badge.svg)](https://snyk.io/test/github/timbru31/cordova-plugin-lottie-splashscreen)\n\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen.github.io/cz-cli/)\n[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n[![npm](https://img.shields.io/npm/v/cordova-plugin-lottie-splashscreen.svg)](https://www.npmjs.com/package/cordova-plugin-lottie-splashscreen)\n\n#### Apache Cordova plugin to show bodymovin/Lottie animations as the splash screen with [Airbnb's Lottie](https://airbnb.io/lottie/) wrapper\n\n### Supported platforms\n\n-   **iOS (11+) (with cordova-ios \u003e= 5.0.0 only)**\n-   **Android (with cordova-android \u003e= 10.0.0 only)**\n\n### Planned platforms\n\n-   **macOS** (currently on hold until cordova-osx has a better Swift and CocoaPods support or cordova-ios gains Catalyst support)\n\n#### Prerequisites/Warnings\n\n#### iOS\n\nYou need to have [CocoaPods](https://cocoapods.org/) installed because [lottie-ios](https://cocoapods.org/pods/lottie-ios) is fetched from there.\n\n```sh\n$ sudo gem install cocoapods\n$ pod setup\n```\n\n##### Caveats\n\nOnly **cordova \u003e= 9.0.0** and **cordova-ios \u003e= 5.0.0** are supported.  \nYou need to specify a valid `SwiftVersion` (minimum is 5.5) in your `config.xml`. (see https://cordova.apache.org/docs/en/latest/config_ref/)\n\n#### Android\n\nAndroidX and Kotlin support is required. Therefore only **cordova-android \u003e= 9.0.0** is supported.  \nIf you use `cordova-android` \u003c10.0.0 then you need to enable Kotlin and AndroidX in your `config.xml` by setting `GradlePluginKotlinEnabled` **and** `AndroidXEnabled` to `true`.  \nIn the [FAQ](FAQ.md) are some examples with common error messages and how to fix them.\n\n### Installation\n\n#### from npm (recommended)\n\n`$ cordova plugin add cordova-plugin-lottie-splashscreen`\n\n#### from git (unstable)\n\n`$ cordova plugin add https://github.com/timbru31/cordova-plugin-lottie-splashscreen.git`\n\n### Usage\n\nThis Apache Cordova plugin is meant as a replacement for the stock [cordova-plugin-splashscreen](https://github.com/apache/cordova-plugin-splashscreen).  \nAn example project can be found in the `example` folder.\n\n#### Methods\n\n-   lottie.splashscreen.hide\n-   lottie.splashscreen.show\n-   lottie.splashscreen.on\n-   lottie.splashscreen.once\n\n##### lottie.splashscreen.hide\n\nThis 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.\n\n```js\nawait lottie.splashscreen.hide();\n```\n\n##### lottie.splashscreen.show\n\nThis 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)\n\n```ts\nawait lottie.splashscreen.show(location?: string, remote?: boolean, width?: number, height?: number)\n```\n\n##### lottie.splashscreen.on\n\nThis 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)\n\n```ts\ntype LottieEvent = 'lottieAnimationStart' | 'lottieAnimationEnd' | 'lottieAnimationCancel' | 'lottieAnimationRepeat';\n\nlottie.splashscreen.on(event: LottieEvent, callback: (ev: Event) =\u003e void);\n```\n\n##### lottie.splashscreen.once\n\nThis 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)\n\n```ts\ntype LottieEvent = 'lottieAnimationStart' | 'lottieAnimationEnd' | 'lottieAnimationCancel' | 'lottieAnimationRepeat';\n\nawait lottie.splashscreen.once(event: LottieEvent).then(event =\u003e console.log(event));\n```\n\n### Preferences\n\n-   `LottieRemoteEnabled` (Boolean, default `false`). Toggles Lottie's remote mode which allows files to be downloaded/displayed from URLs. Example:\n\n```xml\n    \u003cpreference name=\"LottieRemoteEnabled\" value=\"true\" /\u003e\n```\n\n-   `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`).\n\n```xml\n    \u003cpreference name=\"LottieAnimationLocationLight\" value=\"https://assets.lottiefiles.com/datafiles/99nA1a7mkSF3Oz8/data.json\" /\u003e\n```\n\n-   `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`).\n\n```xml\n    \u003cpreference name=\"LottieAnimationLocationDark\" value=\"https://assets.lottiefiles.com/datafiles/99nA1a7mkSF3Oz8/data.json\" /\u003e\n```\n\n-   `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`).\n\n```xml\n    \u003cpreference name=\"LottieAnimationLocation\" value=\"https://assets.lottiefiles.com/datafiles/99nA1a7mkSF3Oz8/data.json\" /\u003e\n```\n\n-   `LottieImagesLocation` (String, default `path of LottieAnimationLocation`). **Android only!** Location of the Lottie images folder specified by the JSON.\n\n```xml\n    \u003cpreference name=\"LottieImagesLocation\" value=\"www/lottie/images\" /\u003e\n```\n\n-   `LottieCancelOnTap` (Boolean, default `false`). Immediately cancels the Lottie animation when the user taps on the screen.\n\n```xml\n    \u003cpreference name=\"LottieCancelOnTap\" value=\"true\" /\u003e\n```\n\n-   `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**!\n\n```xml\n    \u003cpreference name=\"LottieHideTimeout\" value=\"?\" /\u003e \u003c!-- CAUTION: iOS reads this value in **SECONDS**, Android reads this value in **MILLISECONDS**\u003e\n```\n\n-   `LottieBackgroundColorLight` (String, default `#ffffff`). Background color of the overlay in light. Can be used with alpha values, too. (For more information see the [8 digits notation of RGB notation](https://drafts.csswg.org/css-color/#hex-notation))\n\n```xml\n    \u003cpreference name=\"LottieBackgroundColorLight\" value=\"#fff000a3\" /\u003e\n```\n\n-   `LottieBackgroundColorDark` (String, default `#ffffff`). Background color of the overlay in dark mode. Can be used with alpha values, too. (For more information see the [8 digits notation of RGB notation](https://drafts.csswg.org/css-color/#hex-notation))\n\n```xml\n    \u003cpreference name=\"LottieBackgroundColorDark\" value=\"#fff000a3\" /\u003e\n```\n\n-   `LottieBackgroundColor` (String, default `#ffffff`). Background color of the overlay as a fallback if there are no dark or light mode colors defined. Can be used with alpha values, too. (For more information see the [8 digits notation of RGB notation](https://drafts.csswg.org/css-color/#hex-notation))\n\n```xml\n    \u003cpreference name=\"LottieBackgroundColor\" value=\"#fff000a3\" /\u003e\n```\n\n-   `LottieWidth` (Integer, default `200`). Width of the container that's rendering the Lottie animation\n\n```xml\n    \u003cpreference name=\"LottieWidth\" value=\"750\" /\u003e\n```\n\n-   `LottieHeight` (Integer, default `200`). Height of the container that's rendering the Lottie animation\n\n```xml\n    \u003cpreference name=\"LottieHeight\" value=\"750\" /\u003e\n```\n\n-   `LottieRelativeSize` (Boolean, default `false`). Uses width and height values as relative values. Specify them as e.g. `0.3` to have 30%.\n\n```xml\n    \u003cpreference name=\"LottieRelativeSize\" value=\"true\" /\u003e\n```\n\n-   `LottieFullScreen` (Boolean, default `false`). Renders the animation in full screen. Ignores properties above.\n\n```xml\n    \u003cpreference name=\"LottieFullScreen\" value=\"true\" /\u003e\n```\n\n-   `LottieLoopAnimation` (Boolean, default `false`). Loops the animation\n\n```xml\n    \u003cpreference name=\"LottieLoopAnimation\" value=\"true\" /\u003e\n```\n\n-   `LottieAutoHideSplashScreen` (Boolean, default `false`). Hides the Lottie splash screen when the `pageDidLoad` event fired\n\n```xml\n    \u003cpreference name=\"LottieAutoHideSplashScreen\" value=\"true\" /\u003e\n```\n\n-   `LottieEnableHardwareAcceleration` (Boolean, default `false`). **Android only!** Enables hardware acceleration for the animation view. Not really recommended since Lottie decides automatically whether the hardware mode should be used or not.\n\n```xml\n    \u003cpreference name=\"LottieEnableHardwareAcceleration\" value=\"true\" /\u003e\n```\n\n-   `LottieScaleType` (String, default `FIT_CENTER`). **Android only!** Scale type of the view. Can be one of the following: https://developer.android.com/reference/android/widget/ImageView.ScaleType\n\n```xml\n    \u003cpreference name=\"LottieScaleType\" value=\"CENTER_CROP\" /\u003e\n```\n\n-   `LottieFadeOutDuration` (Double for iOS and Integer for Android, default `0`). Duration for the fade out animation. **CAUTION:** iOS reads this value in **SECONDS**, but e.g., `0.5` is supported. Android reads this value in **MILLISECONDS**! the Set to `0` disable the fade out animation.\n\n```xml\n    \u003cpreference name=\"LottieFadeOutDuration\" value=\"?\" /\u003e \u003c!-- CAUTION: iOS reads this value in **SECONDS**, Android reads this value in **MILLISECONDS**\u003e\n```\n\n-   `LottieHideAfterAnimationEnd` (Boolean, default `false`). Hides the Lottie splash screen after the animation has been played. Do not use together with `LottieAutoHideSplashScreen` or `LottieLoopAnimation`\n\n```xml\n    \u003cpreference name=\"LottieHideAfterAnimationEnd\" value=\"true\" /\u003e\n```\n\n-   `LottieCacheDisabled` (Boolean, default `false`). Disables caching of animations.\n\n```xml\n    \u003cpreference name=\"LottieCacheDisabled\" value=\"true\" /\u003e\n```\n\n---\n\nBuilt by (c) Tim Brust and contributors. Released under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOutSystems%2Fcordova-plugin-lottie-splashscreen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOutSystems%2Fcordova-plugin-lottie-splashscreen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOutSystems%2Fcordova-plugin-lottie-splashscreen/lists"}