Installation

Requirements

• An Android application using Kotlin and Jetpack Compose.
• Android 8.0 (API 26) or newer at runtime.
• A toolchain compatible with the Kit version you choose. The documentation release was built against Android API 37 with Java 21 bytecode.

Add the repository

Add Kit’s public repository to your Android project’s settings.gradle.kts. Keep Google Maven and Maven Central for AndroidX and other dependencies.

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven {
            name = "AndroidKit"
            url = uri("https://mamby.github.io/android-kit-docs/maven/")
            content {
                includeGroup("net.mamby.androidkit")
            }
        }
    }
}

Public host repositories should resolve a published version from this endpoint by default. Maven Local can remain an opt-in development source on a maintainer’s machine; contributors and GitHub Actions do not have that machine’s local cache.

Select a version and modules

Set androidKitVersion in your project’s gradle.properties to an exact version listed on the release page:

androidKitVersion=0.1.63

Add the BOM and the modules you use to your application’s build.gradle.kts:

dependencies {
    val androidKitVersion = providers.gradleProperty("androidKitVersion").get()
    implementation(platform("net.mamby.androidkit:bom:$androidKitVersion"))
    implementation("net.mamby.androidkit:compose")
    implementation("net.mamby.androidkit:navigation3")
}

The BOM aligns module versions. navigation3 is only needed when you use Kit’s Navigation 3 state and page renderer. See modules for each artifact’s responsibility.

Integrate with your app

Place Kit’s Compose components beneath AndroidKitTheme. Configure the palette through AndroidKitThemeDefinition; keep typography, geometry and shared control rendering Kit-owned. Start with themes and the component contract.

Consuming applications must also apply the resource validation build gate and declare their supported locales. See localization.

Include the license

Retain the MIT copyright and permission notice when redistributing Kit, including inside an application. Preserve applicable third-party notices as well. Copy the release’s license and third-party notices into app/src/main/assets/androidkit/ so they are included in the APK. The private implementation repository is not needed to download or use a published binary. See license and notices.