KiteConfig/io.github.yuroyami.kiteconfig/KiteSplashScope

KiteSplashScope

abstract class KiteSplashScope @Inject constructor(objects: ObjectFactory) : KiteFlowScope

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

Every fact defaults to the matching KiteConfigLogoExtension fact, so an empty splash { } already works. Presence flows the Android splash res (into build/, one manifest placeholder line) and the desktop JVM splash image. iOS needs the nested rewrite plus ios { rewrite { } }, because its delivery edits Info.plist and the asset catalog.

membermeaningdefaultflow class
imagesplash artlogo.foregroundbuild/
backgroundColorplate behind the artlogo.backgroundColorbuild/
dark { }dark-mode variantnonebuild/
android { theme }app theme the generated style inheritsrequired for Androidbuild/
rewrite { }arms the iOS deliverynot armedrewrite
skip(p) / only(p)flow controlflow everywheren/a

Constructors

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

Types

Link copied to clipboard
abstract class AndroidCorner : KitePlatformRef

Android's splash corner: which app theme the generated style inherits.

Link copied to clipboard
abstract class DarkVariant

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

Link copied to clipboard
abstract class KiteSplashRewrite

Options for the armed iOS splash delivery. Empty today, kept for growth.

Properties

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

Solid plate behind the art, #RRGGBB or #AARRGGBB. Default: logo.backgroundColor.

Link copied to clipboard
Link copied to clipboard
val desktop: KitePlatformRef

Platform token for skip(desktop) / only(desktop).

Link copied to clipboard
abstract val image: RegularFileProperty

Splash art. Default: logo.foreground.

Link copied to clipboard
val ios: KitePlatformRef

Platform token for skip(ios) / only(ios).

Functions

Link copied to clipboard
fun android(action: Action<in KiteSplashScope.AndroidCorner>)
Link copied to clipboard
fun dark(action: Action<in KiteSplashScope.DarkVariant>)
Link copied to clipboard
fun only(vararg refs: KitePlatformRef): <Error class: unknown class>

This fact flows only to the given platforms.

Link copied to clipboard
fun rewrite(action: Action<in KiteSplashScope.KiteSplashRewrite>)

Arms the iOS splash delivery: UILaunchScreen in Info.plist plus asset catalog entries, running with kiteRewriteXcode. Source edits, so dryRun, backups, and onConflict apply.

Link copied to clipboard
fun skip(vararg refs: KitePlatformRef): <Error class: unknown class>

This fact does not flow to the given platforms.