Android¶

io.github.thomaskioko.gradle.plugins.android

This plugin configures an Android library module. It applies the Android library plugin, the Kotlin plugin and Base. It also adds the android {} block inside scaffold {}.

plugins {
    id("io.github.thomaskioko.gradle.plugins.android")
}

scaffold {
    android {
        useCompose()
    }
}

The namespace comes from the module path and the package.name property. No module sets its own.

A Kotlin Multiplatform module gets the same options once it calls addAndroidTarget(). See the Multiplatform page.

Options¶

Option	What it does
`useCompose()`	Applies the Compose compiler plugin and adds the Compose runtime
`useComposeTests()`	Adds Compose UI test and Robolectric dependencies for running UI tests on the JVM
`useRoborazzi()`	Applies Roborazzi and adds the Compose UI test, Robolectric and Roborazzi dependencies
`enableAndroidTests(testInstrumentationRunner = null, clearPackageData = true)`	Opts into instrumentation tests and applies the test orchestrator
`useManagedDevices(deviceName = "pixel6Api34", device = "Pixel 6", apiLevel = 34, systemImageSource = ...)`	Registers a managed virtual device for instrumentation tests
`useBaselineProfile(benchmarkProject = null)`	Applies the baseline profile consumer plugin and connects the benchmark module
`minSdkVersion(minSdkVersion)`	Overrides the minimum SDK for this module
`enableAndroidResources()`	Turns on resource processing
`enableBuildConfig()`	Turns on the Android `BuildConfig` feature
`consumerProguardFiles(vararg files)`	Bundles the named rules into consumers of this library
`manifestPlaceholders(placeholders)`	Sets manifest placeholders on every variant
`libraryConfiguration(configuration)`	Reaches the underlying Android extension for anything not listed here

Core library desugaring¶

If you declare android-desugarJdkLibs in your version catalog, the plugin turns on core library desugaring and adds the dependency for you. If you leave it out, desugaring stays off. We think that's the right default for a module that doesn't need it.

[libraries]
android-desugarJdkLibs = { module = "com.android.tools:desugar_jdk_libs", version = "2.1.5" }

Full detail in the API reference.