This Day In History Jetpack Compose App - Splash Screen

Objective:

Add a splash screen to our app. At the end of this exercise, the splash screen will appear on cold and warm start-up and look and behave as below:

Components built

We will add or modify the following components:

• Splash.xml: Add Splash resource in the res/value directory
• ic_catapplogo_background.xml: Add this resource to specify the color of the splash screen background.
• Manifest.xml: Modify the manifest to point to the splash theme on start-up.
• MainActivity.kt: Modify the onCreate method to launch the splash screen and set conditions for dismissing it.

Code

Splash.xml

Add splash.xml to the res/values directory.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <style name="Theme.App.Starting" parent="Theme.SplashScreen">
        <item name="windowSplashScreenAnimatedIcon">@drawable/catt2</item>
        <item name="windowSplashScreenBackground">@color/ic_catapplogo_background>
        <item name="postSplashScreenTheme">@style/Theme.AppCompat.NoActionBar</item>
    </style>
</resources>

ic_catapplogo_background.xml in the res/value directory.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="ic_catapplogo_background">#FFFFFF</color>
</resources>

Manifest.xml

Modify android manifest.xml in the app module:

    <application
            android:allowBackup="true"
            android:dataExtractionRules="@xml/data_extraction_rules"
            android:fullBackupContent="@xml/backup_rules"
            android:icon="@mipmap/ic_catapplogo"
            android:label="@string/app_name"
            android:roundIcon="@mipmap/ic_catapplogo_round"
            android:supportsRtl="true"
            android:theme="@style/Theme.App.Starting"
            android:localeConfig="@xml/locales_config"
            tools:targetApi="tiramisu">
            <activity
                android:name=".MainActivity"
                android:exported="true"
                android:theme="@style/Theme.App.Starting">
                <intent-filter>
                    <action android:name="android.intent.action.MAIN" />
                    <category android:name="android.intent.category.LAUNCHER" />
                </intent-filter>
            </activity>
        </application>
    

Update MainActivity; add installSplashScreen().apply method in the onCreate hook.

    class MainActivity : AppCompatActivity() {
        private var isStatePendingRestore = true

        override fun onCreate(savedInstanceState: Bundle?) {
            
            installSplashScreen().apply {
                setKeepOnScreenCondition {
                    return@setKeepOnScreenCondition isStatePendingRestore
                }
            }

            enableEdgeToEdge()
            super.onCreate(savedInstanceState)

            runUi()
        }