KiteConfig/io.github.yuroyami.kiteconfig/KiteConfigLogoExtension

KiteConfigLogoExtension

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

The logo topic, inside kiteConfig { logo { ... } }: one icon for every platform.

kiteConfig {
    logo {
        foreground = file("art/logo_fg.png")
        backgroundColor = "#102A43"
    }
}

Declaring art is a fact, not an action. Desktop app icons flow into build/ automatically when a desktop app exists (stop that with skip(desktop)). Android res and the iOS asset catalog are source, so they need the nested rewrite block, and the armed task only runs when you invoke it by name.

Platform	Output
Android	`ic_launcher`, `ic_launcher_round`, both adaptive layers, every density
Android, `compileSdk` 33+	the themed-icon `<monochrome>` wrapper as well
Apple	one `AppIcon-1024.png` plus a single-image universal `Contents.json`
Desktop	`.icns`, `.ico`, and `.png` wired into Compose Desktop packaging

Apple rejects icons that carry transparency, so the Apple output is always flattened onto your background. Android keeps the two adaptive layers.

Constructors

KiteConfigLogoExtension

@Inject

constructor(objects: ObjectFactory)

Types

abstract class AndroidCorner : KitePlatformRef

Android's logo corner: the adaptive-icon safe zone.

abstract class DesktopCorner : KitePlatformRef

Desktop's logo corner: icon shaping for packaging.

abstract class LogoRewrite

Options for the armed source rewrite.

Properties

val android: KiteConfigLogoExtension.AndroidCorner

abstract val background: RegularFileProperty

PNG holding the plate the foreground sits on.

backgroundColor

abstract val backgroundColor: Property<String>

Solid background color, written as #RRGGBB or #AARRGGBB. Alpha comes first, the Android convention. Set this or background, never both.

val desktop: KiteConfigLogoExtension.DesktopCorner

abstract val foreground: RegularFileProperty

PNG holding the artwork that sits on top: your mark, your glyph.

Functions

fun android(action: Action<in KiteConfigLogoExtension.AndroidCorner>)

fun desktop(action: Action<in KiteConfigLogoExtension.DesktopCorner>)

fun only(vararg refs: KitePlatformRef): <Error class: unknown class>

This fact flows only to the given platforms.

fun rewrite(action: Action<in KiteConfigLogoExtension.LogoRewrite>)

Arms the logo task that writes Android res and the iOS asset catalog. Nothing runs until you invoke the task by name; dryRun and backups apply.

fun skip(vararg refs: KitePlatformRef): <Error class: unknown class>

This fact does not flow to the given platforms.