راه‌اندازی افزونه Compose Compiler Gradle

برای Gradle، از افزونه Compose Compiler Gradle برای راه‌اندازی و پیکربندی Compose استفاده کنید.

راه‌اندازی با کاتالوگ‌های نسخه Gradle

افزونه Compose Compiler Gradle را راه‌اندازی کنید:

  1. در فایل libs.versions.toml، هرگونه ارجاع به Compose Compiler را بردارید.

  2. در بخش‌های versions و plugins، وابستگی جدید را اضافه کنید:

    [versions]
kotlin = "2.4.10"

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

// Add this line
compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }

  3. در فایل ریشه build.gradle.kts پروژه، موارد زیر را به بخش plugins اضافه کنید.

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

  4. در هر واحدی که از Compose استفاده می‌کند، افزایه را اعمال کنید:

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

اگر پروژه از راه‌اندازی پیش‌فرض استفاده می‌کرد، اکنون باید ساخته و کامپایل شود. اگر گزینه‌های سفارشی را در کامپایلر Compose پیکربندی کرده است، بخش بعدی را دنبال کنید.

راه‌اندازی «گردآورنده Compose» بدون فهرست‌های نسخه Gradle

افزایه را به build.gradle.kts فایل مرتبط با واحدهایی که در آن‌ها از Compose استفاده می‌شود اضافه کنید:

plugins {
    id("org.jetbrains.kotlin.plugin.compose") version "2.4.10" // this version matches your Kotlin version
}

مسیر کلاس را به فایل build.gradle.kts پروژه سطح بالای خود اضافه کنید:

buildscript {
    dependencies {
        classpath("org.jetbrains.kotlin.plugin.compose:org.jetbrains.kotlin.plugin.compose.gradle.plugin:2.4.10")
    }
}

گزینه‌های پیکربندی با افزایه Gradle «گردآورنده Compose»

برای پیکربندی کامپایلر Compose بااستفاده از افزایه Gradle، بلوک composeCompiler را به فایل build.gradle.kts پیمانه در سطح بالا اضافه کنید:

android { … }

composeCompiler {
    reportsDestination = layout.buildDirectory.dir("compose_compiler")
    stabilityConfigurationFile = rootProject.layout.projectDirectory.file("stability_config.conf")
}

برای مشاهده فهرست کامل گزینه‌های دردسترس، به اسناد مراجعه کنید.

راه‌اندازی وابستگی‌های Compose

همیشه از جدیدترین نسخه Compose BOM استفاده کنید: 2026.09.00.

پرچم compose را روی true در Android BuildFeatures تنظیم کنید تا عملکرد Compose در Android Studio فعال شود.

تعریف زیر را به فایل build.gradle برنامه‌تان اضافه کنید:

شیک

android {
    buildFeatures {
        compose true
    }
}

کاتلین

android {
    buildFeatures {
        compose = true
    }
}

«فهرست مواد اولیه Compose» و زیرمجموعه وابستگی‌های کتابخانه Compose را اضافه کنید:

شیک

dependencies {

    def composeBom = platform('androidx.compose:compose-bom:2026.09.00')
    implementation composeBom
    androidTestImplementation composeBom

    // Choose one of the following:
    // Material Design 3
    implementation 'androidx.compose.material3:material3'
    // or skip Material Design and build directly on top of foundational components
    implementation 'androidx.compose.foundation:foundation'
    // or only import the main APIs for the underlying toolkit systems,
    // such as input and measurement/layout
    implementation 'androidx.compose.ui:ui'

    // Android Studio Preview support
    implementation 'androidx.compose.ui:ui-tooling-preview'
    debugImplementation 'androidx.compose.ui:ui-tooling'

    // UI Tests
    androidTestImplementation 'androidx.compose.ui:ui-test-junit4'
    debugImplementation 'androidx.compose.ui:ui-test-manifest'

    // Optional - Add window size utils
    implementation 'androidx.compose.material3.adaptive:adaptive'

    // Optional - Integration with activities
    implementation 'androidx.activity:activity-compose:1.13.0'
    // Optional - Integration with ViewModels
    implementation 'androidx.lifecycle:lifecycle-viewmodel-compose:2.11.0'
    // Optional - Integration with LiveData
    implementation 'androidx.compose.runtime:runtime-livedata'
    // Optional - Integration with RxJava
    implementation 'androidx.compose.runtime:runtime-rxjava2'

}

کاتلین

dependencies {

    val composeBom = platform("androidx.compose:compose-bom:2026.09.00")
    implementation(composeBom)
    androidTestImplementation(composeBom)

    // Choose one of the following:
    // Material Design 3
    implementation("androidx.compose.material3:material3")
    // or skip Material Design and build directly on top of foundational components
    implementation("androidx.compose.foundation:foundation")
    // or only import the main APIs for the underlying toolkit systems,
    // such as input and measurement/layout
    implementation("androidx.compose.ui:ui")

    // Android Studio Preview support
    implementation("androidx.compose.ui:ui-tooling-preview")
    debugImplementation("androidx.compose.ui:ui-tooling")

    // UI Tests
    androidTestImplementation("androidx.compose.ui:ui-test-junit4")
    debugImplementation("androidx.compose.ui:ui-test-manifest")

    // Optional - Add window size utils
    implementation("androidx.compose.material3.adaptive:adaptive")

    // Optional - Integration with activities
    implementation("androidx.activity:activity-compose:1.13.0")
    // Optional - Integration with ViewModels
    implementation("androidx.lifecycle:lifecycle-viewmodel-compose:2.11.0")
    // Optional - Integration with LiveData
    implementation("androidx.compose.runtime:runtime-livedata")
    // Optional - Integration with RxJava
    implementation("androidx.compose.runtime:runtime-rxjava2")

}

سازگاری compileSdk و «افزایه Android Gradle»

نسخه‌های منتشرشده کتابخانه Compose به‌طور مداوم جدیدترین نسخه‌های compileSdk را اتخاذ می‌کنند تا دسترسی به جدیدترین ویژگی‌های Android را فراهم کنند. نسخه‌های جدیدتر compileSdk به نسخه‌های جدیدتر «افزایه Android Gradle» نیاز دارند، بنابراین برای استفاده از نسخه‌های جدید Compose، پروژه‌ها نیز باید از نسخه‌های جدید «افزایه Android Gradle» استفاده کنند. توصیه می‌کنیم compileSdk پروژه‌تان را با جدیدترین نسخه‌های منتشرشده به‌روز نگه دارید. ‫compileSdk با targetSdk مرتبط نیست.

برای مثال، از Compose نسخه ۱.۱۲.۰ به بعد، پروژه‌ها باید از compileSdk 37 و «افزایه Android Gradle»‏ (AGP) نسخه ۹ استفاده کنند.

برای بررسی اینکه کدام نسخه AGP برای سطوح مختلف API پشتیبانی می‌شود، مستندات پشتیبانی سطح API افزایه Android Gradle را ببینید.