About this project

Adding splash screens to Compose Multiplatform (CMP) desktop applications often involves repetitive code for window management and state synchronization. Splashify provides a simple way to integrate splash screens into CMP desktop apps with minimal configuration.

Demo

Check out Splashify in action:

splashify-demo-video.mp4

A simple Compose Multiplatform desktop app showcasing splash screen integration using Splashify.

Installation guide

To get started, add the Splashify dependency to your existing Gradle project. To make Splashify available in any module's classpath, copy and paste the following line into your module's build.gradle.kts file under the dependencies block as shown below.

kotlin {
    sourceSets {
        jvmMain.dependencies {
            // Other dependencies will go here
            implementation("io.github.sudarshanmhasrup.splashify:splashify:1.0.0-alpha1")
        }
    }
}

To quickly copy the dependency, you can use the following command:

implementation("io.github.sudarshanmhasrup.splashify:splashify:1.0.0-alpha1")

If your project uses a version catalog for centralized dependency management, then add the following lines to your libs.versions.toml file:

[versions]
# Other version declarations will go here
splashify = "1.0.0-alpha1"

[libraries]
# Other libraries declarations will go here
splashify = { module = "io.github.sudarshanmhasrup.splashify:splashify", version.ref = "splashify" }

Then you can refer to the dependency in your module's build.gradle.kts file like this:

kotlin {
    sourceSets {
        jvmMain.dependencies {
            // Other dependencies will go here
            implementation(libs.splashify)
        }
    }
}

To quickly copy the dependency, you can use the following command:

implementation(libs.splashify)

Usage guide

Follow these examples to integrate Splashify into your Compose Multiplatform desktop app.

Step 1: Wrap your app using SplashifyApp

The content block should contain your main application Window.

fun main() = application {
    SplashifyApp(
        splashScreen = { SplashScreen() }
    ) {
        Window(
            title = "My App",
            onCloseRequest = ::exitApplication
        ) {
            MainApp()
        }
    }
}

Step 2: Create a simple splash screen

Use SimpleSplashScreen when you want full control over the splash content.

@Composable
fun SplashScreen() {
    val size = SplashScreenSize(
        width = 600.dp,
        height = 380.dp
    )

    val style = SplashScreenStyle(
        backgroundColor = Color.Black,
        cornerRadius = 16.dp
    )

    SimpleSplashScreen(
        size = size,
        style = style
    ) { progress ->
        Text(
            text = "Loading ${(progress * 100).toInt()}%",
            color = Color.White
        )
    }
}

Step 3: Use progressive splash screen

Use ProgressiveSplashScreen when you want a built-in progress indicator.

@Composable
fun SplashScreen() {
    ProgressiveSplashScreen {
        Text(text = "Splashify")
    }
}

Step 4: Customize progressive splash screen

You can customize the window size, background, corner radius, and progress indicator.

@Composable
fun SplashScreen() {
    val size = SplashScreenSize(
        width = 600.dp,
        height = 380.dp
    )

    val style = SplashScreenStyle(
        backgroundColor = Color.Black,
        cornerRadius = 16.dp
    )

    val indicatorStyle = SplashIndicatorStyle(
        color = Color.White,
        trackColor = Color.Black,
        thickness = 2.dp
    )

    ProgressiveSplashScreen(
        size = size,
        style = style,
        indicatorStyle = indicatorStyle
    ) {
        Text(
            text = "Splashify",
            fontSize = 28.sp,
            fontWeight = FontWeight.SemiBold,
            color = Color.White
        )
    }
}

Available configuration classes

• SplashScreenSize: Controls splash window width and height.
• SplashScreenStyle: Controls splash background color and corner radius.
• SplashIndicatorStyle: Controls progress indicator color, track color, and thickness.

Features

• Simple API for quick integration
• Internal splash state handling
• Built-in support for progress tracking
• Customizable size, style, and indicators

Supported platforms

Platform	Target
Desktop	jvm()

Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request.

Thank you! 🙌

Thank you so much for checking out the Splashify project. If you like my work on this project, feel free to give a star to the repository. Happy coding!