capacitor-animated-splash

This plugin allows you to display a Lottie-based animated splash screen on Android with configurable animation, loop, and background colors for light/dark themes.

*Ios is not supported yet

Install

npm install capacitor-animated-splash
npx cap sync

Configiration

Add the following code to: android\app\src\main\java\ionic\<your-package>\MainActivity.java

import android.os.Bundle;
import android.content.Intent;
import com.sangilov.plugins.animatedsplash.SplashActivity; // <-- Important

public class MainActivity extends BridgeActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        Intent intent = new Intent(this, SplashActivity.class);
        intent.putExtra("animation", "splash.json"); // path to lottie animation json file For light theme
        intent.putExtra("darkAnimation", "splash.json"); // path to lottie animation json file For dark theme *optional, if not specified, will be used "animation"
        intent.putExtra("loop", false); // loop animation
        intent.putExtra("lightBackground", "#FFFFFF"); // background for light theme
        intent.putExtra("darkBackground", "#000000"); // background for dark theme
        startActivity(intent);

        super.load();
    }
}

Add this activity to: android\app\src\main\AndroidManifest.xml

<activity
    android:name="com.sangilov.plugins.animatedsplash.SplashActivity"
    android:exported="true"
    android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"
    android:screenOrientation="portrait" 
/>

Lottie JSON file location

• Place your animations in: android/app/src/main/assets/

• The filename should match the "animation" and "darkAnimation" value in MainActivity.java.

API

• hide(...)

hide(...)

hide(options?: { duration?: number | undefined; } | undefined) => Promise<void>

| Param | Type | | ------------- | ----------------------------------- | | options | { duration?: number; } |