KiteSplashScope

abstract class KiteSplashScope @Inject constructor(objects: ObjectFactory)

The splash topic: the launch screen for Android, iOS, and desktop.

Splash is off until you turn it on. Artwork, colors, a dark variant, and an empty block all leave it off, because a launch screen is a visible change to somebody's app and configuring art is not the same as asking for one.

kiteConfig {
splash {
enabled = true
dark { backgroundColor = "#000000" }
}
android { splash { theme = "AppTheme" } }
ios { splash { enabled = false } } // this one platform opts out
}
membermeaningdefault
enableddeliver a launch screenfalse
imagethe artthe effective logo { foreground }
backgroundColorthe plate behind itthe effective logo color background
dark { }dark-mode varianton once one dark value is set

Every fallback is resolved per platform, so iOS art follows the iOS logo. A logo whose background is an image gives the splash no color: set splash { backgroundColor } in that case.

Inheritors

Constructors

Link copied to clipboard
@Inject
constructor(objects: ObjectFactory)

Types

Link copied to clipboard
abstract class DarkVariant

Dark-mode overrides. Unset members fall back to the light values.

Properties

Link copied to clipboard
abstract val backgroundColor: Property<String>

Solid plate behind the art, #RRGGBB or #AARRGGBB, alpha first. Default: the effective logo background, when that background is a color.

Link copied to clipboard
Link copied to clipboard
abstract val enabled: Property<Boolean>

Deliver a launch screen. Default: false at the root.

Link copied to clipboard
abstract val image: RegularFileProperty

Splash art. Default: the effective logo { foreground } for this platform.

Functions

Link copied to clipboard
fun dark(action: Action<in KiteSplashScope.DarkVariant>)