{"_id":"@amjed.gabteni/capacitor-lottie-splashscreen","_rev":"2-e2f48bea02c656ff037262edf385d970","name":"@amjed.gabteni/capacitor-lottie-splashscreen","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@amjed.gabteni/capacitor-lottie-splashscreen","version":"0.0.1","keywords":["capacitor","plugin","lottie","splashscreen","ios","android"],"author":{"name":"amjed gabteni","email":"amjed.gabteni@gmail.com"},"license":"MIT","_id":"@amjed.gabteni/capacitor-lottie-splashscreen@0.0.1","maintainers":[{"name":"amjed.gabteni","email":"amjed.gabteni@gmail.com"}],"homepage":"https://github.com/amjedgabteni/capacitor-lottie-splashscreen#readme","bugs":{"url":"https://github.com/amjedgabteni/capacitor-lottie-splashscreen/issues"},"dist":{"shasum":"3c381b57fa9216dfa61b1dcd2f5be8dfa147bfbe","tarball":"https://registry.npmjs.org/@amjed.gabteni/capacitor-lottie-splashscreen/-/capacitor-lottie-splashscreen-0.0.1.tgz","fileCount":20,"integrity":"sha512-l6Jv20//ud0kBX9wavms65wm37Fg5qwyUvikb4jtyT8Lq/swyDz0SLNt54uNDVlCISOZDJ6//27YTit+QCSPQg==","signatures":[{"sig":"MEYCIQD5CkgeSFrYuPZecZ8BJhzZuYE+P5077aO2PVk/lpRC5gIhAIO47+5txI7uMt/njgs4gbzBVDDK9h1Oe3gd7AT8V9Hs","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":43651},"main":"dist/esm/index.js","types":"dist/esm/index.d.ts","module":"dist/esm/index.js","gitHead":"d4072d4f3e008289cc6b929c1e991e76554bea36","scripts":{"fmt":"npm run prettier -- --write","lint":"tsc --noEmit","test":"npm run test:unit","build":"npm run clean && tsc","clean":"rimraf ./dist","docgen":"docgen --api LottieSplashscreenPlugin --output-readme README.md","prettier":"prettier \"**/*.{ts,js,json,md}\"","test:unit":"echo \"No unit tests yet\"","prepublishOnly":"npm run lint && npm run build"},"_npmUser":{"name":"amjed.gabteni","email":"amjed.gabteni@gmail.com"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"url":"git+https://github.com/amjedgabteni/capacitor-lottie-splashscreen.git","type":"git"},"_npmVersion":"10.7.0","description":"Capacitor plugin to render Lottie-powered splash screens on iOS and Android.","directories":{},"_nodeVersion":"22.2.0","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.0.1","prettier":"^3.4.0","typescript":"~5.8.2","@capacitor/ios":"^7.0.0","@capacitor/core":"^7.0.0","@capacitor/docgen":"^0.3.0","@capacitor/android":"^7.0.0"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-lottie-splashscreen_0.0.1_1776126410373_0.6876635473700834","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"@amjed.gabteni/capacitor-lottie-splashscreen","version":"0.0.2","description":"Capacitor plugin to render Lottie-powered splash screens on iOS and Android.","main":"dist/esm/index.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","author":{"name":"amjed gabteni","email":"amjed.gabteni@gmail.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/amjedgabteni/capacitor-lottie-splashscreen.git"},"bugs":{"url":"https://github.com/amjedgabteni/capacitor-lottie-splashscreen/issues"},"homepage":"https://github.com/amjedgabteni/capacitor-lottie-splashscreen#readme","keywords":["capacitor","plugin","lottie","splashscreen","ios","android"],"scripts":{"clean":"rimraf ./dist","build":"npm run clean && tsc","docgen":"docgen --api LottieSplashscreenPlugin --output-readme README.md","lint":"tsc --noEmit","fmt":"npm run prettier -- --write","prettier":"prettier \"**/*.{ts,js,json,md}\"","prepublishOnly":"npm run lint && npm run build","test":"npm run test:unit","test:unit":"echo \"No unit tests yet\""},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"devDependencies":{"@capacitor/android":"^7.0.0","@capacitor/core":"^7.0.0","@capacitor/docgen":"^0.3.0","@capacitor/ios":"^7.0.0","prettier":"^3.4.0","rimraf":"^6.0.1","typescript":"~5.8.2"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"_id":"@amjed.gabteni/capacitor-lottie-splashscreen@0.0.2","gitHead":"0779128846b2b57573d596cef014e70aa9e2901c","_nodeVersion":"22.2.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-YxjuKooFC3IEQH5g5ek4CtSAAw/NwNx6wK4XpbgYjEmtv4k4zkRXjR4zjwKLO1dtLKUw2A0M7Izwe8krRwYj4A==","shasum":"978299e79a0a2314034385b77ffd90410bbc32f8","tarball":"https://registry.npmjs.org/@amjed.gabteni/capacitor-lottie-splashscreen/-/capacitor-lottie-splashscreen-0.0.2.tgz","fileCount":20,"unpackedSize":43650,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCshvwsXaROOvwhW2lgn4zafWt/0MgkgAgvIHPJlJ9xYwIhAJ2ao+6ex6HUnmWqNLVziyS7yu6KH6z8+JcVtYFfiodh"}]},"_npmUser":{"name":"amjed.gabteni","email":"amjed.gabteni@gmail.com"},"directories":{},"maintainers":[{"name":"amjed.gabteni","email":"amjed.gabteni@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/capacitor-lottie-splashscreen_0.0.2_1776130218389_0.8879738737380085"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-14T00:26:50.227Z","modified":"2026-04-14T01:30:18.959Z","0.0.1":"2026-04-14T00:26:50.531Z","0.0.2":"2026-04-14T01:30:18.531Z"},"bugs":{"url":"https://github.com/amjedgabteni/capacitor-lottie-splashscreen/issues"},"author":{"name":"amjed gabteni","email":"amjed.gabteni@gmail.com"},"license":"MIT","homepage":"https://github.com/amjedgabteni/capacitor-lottie-splashscreen#readme","keywords":["capacitor","plugin","lottie","splashscreen","ios","android"],"repository":{"type":"git","url":"git+https://github.com/amjedgabteni/capacitor-lottie-splashscreen.git"},"description":"Capacitor plugin to render Lottie-powered splash screens on iOS and Android.","maintainers":[{"name":"amjed.gabteni","email":"amjed.gabteni@gmail.com"}],"readme":"# @amjed.gabteni/capacitor-lottie-splashscreen\n\nCapacitor plugin to show a native full-screen Lottie splash overlay on iOS and Android.\n\n## Install\n\n```bash\nnpm install @amjed.gabteni/capacitor-lottie-splashscreen\nnpx cap sync\n```\n\n## Platform install help\n\n- [Install overview](./docs/install.md)\n- [iOS install help](./docs/install-ios.md)\n- [Android install help](./docs/install-android.md)\n\n## Project files\n\n- [Contributing guide](./CONTRIBUTING.md)\n- [Code of conduct](./CODE_OF_CONDUCT.md)\n- [Security policy](./SECURITY.md)\n- [License](./LICENSE)\n- [GitHub setup](./docs/github-setup.md)\n- [npm org publish guide](./docs/npm-org-publish.md)\n\n## iOS setup\n\n1. Add your animation JSON file to your iOS app bundle (for example `splash.json`).\n2. Ensure it is copied into the app target.\n\n## Android setup\n\n1. Place your animation JSON file in `android/app/src/main/assets/` (for example `splash.json`).\n2. Rebuild and sync Capacitor.\n\n## Launch config\n\nConfigure launch behavior in `capacitor.config.ts`:\n\n```ts\nplugins: {\n  LottieSplashscreen: {\n    launchAutoShow: true,\n    launchAnimationName: 'splash',\n    launchLoop: true,\n    launchSpeed: 1,\n    launchBackgroundColor: '#000000',\n    launchAutoHideMs: 2500,\n    launchSafetyHideMs: 7000,\n  },\n}\n```\n\nNotes:\n\n- `launchAutoShow`: enables automatic splash on app launch.\n- `launchAutoHideMs`: set `0` to keep the splash visible until `hide()` is called.\n- `launchSafetyHideMs`: force-hide safety timeout to avoid stuck overlays.\n- `launchAnimationName`: accepts either `splash`, `splash.json`, or bundle paths like `public/splash`.\n\n## API\n\n<docgen-index>\n\n* [`show(...)`](#show)\n* [`hide(...)`](#hide)\n* [`preload(...)`](#preload)\n* [`setAnimation(...)`](#setanimation)\n* [Interfaces](#interfaces)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### show(...)\n\n```typescript\nshow(options?: ShowOptions | undefined) => any\n```\n\nShow the native Lottie splash overlay.\n\n| Param         | Type                                                |\n| ------------- | --------------------------------------------------- |\n| **`options`** | <code><a href=\"#showoptions\">ShowOptions</a></code> |\n\n**Returns:** <code>any</code>\n\n--------------------\n\n\n### hide(...)\n\n```typescript\nhide(options?: HideOptions | undefined) => any\n```\n\nHide the native Lottie splash overlay.\n\n| Param         | Type                                                |\n| ------------- | --------------------------------------------------- |\n| **`options`** | <code><a href=\"#hideoptions\">HideOptions</a></code> |\n\n**Returns:** <code>any</code>\n\n--------------------\n\n\n### preload(...)\n\n```typescript\npreload(options: PreloadOptions) => any\n```\n\nPreload an animation composition for faster startup display.\n\n| Param         | Type                                                      |\n| ------------- | --------------------------------------------------------- |\n| **`options`** | <code><a href=\"#preloadoptions\">PreloadOptions</a></code> |\n\n**Returns:** <code>any</code>\n\n--------------------\n\n\n### setAnimation(...)\n\n```typescript\nsetAnimation(options: SetAnimationOptions) => any\n```\n\nUpdate the default animation used by future `show()` calls.\n\n| Param         | Type                                                                |\n| ------------- | ------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#setanimationoptions\">SetAnimationOptions</a></code> |\n\n**Returns:** <code>any</code>\n\n--------------------\n\n\n### Interfaces\n\n\n#### ShowOptions\n\n| Prop                  | Type                 | Description                                                                                           |\n| --------------------- | -------------------- | ----------------------------------------------------------------------------------------------------- |\n| **`animationName`**   | <code>string</code>  | Animation file name from the native app bundle/assets. You can pass either `splash` or `splash.json`. |\n| **`loop`**            | <code>boolean</code> | Whether the animation should loop forever.                                                            |\n| **`speed`**           | <code>number</code>  | Playback speed where 1 is normal speed.                                                               |\n| **`backgroundColor`** | <code>string</code>  | Background color as CSS hex (for example `#0f172a`).                                                  |\n| **`autoHideMs`**      | <code>number</code>  | Auto-hide timeout in milliseconds. Set 0 or omit to keep splash visible until `hide()` is called.     |\n\n\n#### HideOptions\n\n| Prop            | Type                | Description                        |\n| --------------- | ------------------- | ---------------------------------- |\n| **`fadeOutMs`** | <code>number</code> | Fade out duration in milliseconds. |\n\n\n#### PreloadOptions\n\n| Prop                | Type                | Description                             |\n| ------------------- | ------------------- | --------------------------------------- |\n| **`animationName`** | <code>string</code> | Animation file name from native assets. |\n\n\n#### SetAnimationOptions\n\n| Prop                | Type                | Description                             |\n| ------------------- | ------------------- | --------------------------------------- |\n| **`animationName`** | <code>string</code> | Animation file name from native assets. |\n\n</docgen-api>\n\n## Usage\n\n```ts\nimport { LottieSplashscreen } from '@amjed.gabteni/capacitor-lottie-splashscreen';\n\nawait LottieSplashscreen.preload({ animationName: 'splash' });\nawait LottieSplashscreen.show({\n  animationName: 'splash',\n  loop: true,\n  speed: 1,\n  backgroundColor: '#020617',\n});\n\n// after app bootstrap\nawait LottieSplashscreen.hide({ fadeOutMs: 220 });\n```\n","readmeFilename":"README.md"}