Scribd
Upload
81 views

Compose Compiler Gradle Plugin - Jetpack Compose - Android Developers

Uploaded by

mywire.ac.01
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
81 views

Compose Compiler Gradle Plugin - Jetpack Compose - Android Developers

Uploaded by

mywire.ac.01
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

Compose Compiler Gradle

plugin
For Gradle users, you can use the Compose Compiler Gradle plugin to make setting up
and configuring Compose easier.

Note: The Compose Compiler Gradle Plugin is only available from Kotlin 2.0+. For migration
instructions, see "Jetpack Compose compiler moving to the Kotlin repository"
(https://android-developers.googleblog.com/2024/04/jetpack-compose-compiler-moving-to-kotlin-
repository.html)
. For an example migration, see the Compose Samples PR
(https://github.com/android/compose-samples/pull/1354) in the Compose samples.

Set up with Gradle version catalogs


The following instructions outline how how can set up the Compose Compiler Gradle
plugin:

1. In your libs.versions.toml file, remove any reference to the Compose compiler

2. In the plugins section, add the following new dependency

[versions]
kotlin = "2.0.0"

[plugins]
org-jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version

// Add this line


compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref

1. In your projects root build.gradle.kts file, add the following to the plugins
section:
plugins {
// Existing plugins
alias(libs.plugins.compose.compiler) apply false
}

1. In each module that uses Compose, apply the plugin:

plugins {
// Existing plugins
alias(libs.plugins.compose.compiler)
}

Your app should now build and compile if you are using the default set up. If you had
configured custom options on the Compose compiler, see the following section.

Set up without Gradle version catalogs


To set up the Compose Compiler Gradle plugin without version catalogs, add the
following plugin to build.gradle.kts files associated with modules you use Compose:

plugins {
id("org.jetbrains.kotlin.plugin.compose") version "2.0.0" // this version
}

Configuration options with the Compose Compiler


Gradle Plugin
To configure the Compose compiler using the Gradle plugin, add the composeCompiler
block to the module's build.gradle.kts file at the top level.
android { … }

composeCompiler {
enableStrongSkippingMode = true

reportsDestination = layout.buildDirectory.dir("compose_compiler")
stabilityConfigurationFile = rootProject.layout.projectDirectory.file("st
}

For the full list of available options, see the documentation


(https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-compiler.html#compose-
compiler-options-dsl)
.

Content and code samples on this page are subject to the licenses described in the Content License
(/license). Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2024-04-29 UTC.

You might also like