Quick Start

Integrate BetterAndroid into your project.

Project Requirements

The project needs to be created using Android Studio or IntelliJ IDEA and be of Android or Kotlin Multiplatform type with integrated Kotlin environment dependencies.

• Android Studio (It is recommended to get the latest version from here)

• IntelliJ IDEA (It is recommended to get the latest version from here)

• Kotlin 1.9.0+, Gradle 8+, Java 17+, Android Gradle Plugin 8+

Configure Repositories

The dependencies of BetterAndroid are published in Maven Central and our public repository. You can use the following method to configure repositories.

We recommend using Kotlin DSL as the Gradle build script language.

Configure repositories in your project's build.gradle.kts.

repositories {
    google()
    mavenCentral()
    // (Optional) You can add this URL to use our public repository
    // When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup
    // For details, please visit: https://github.com/HighCapable/maven-repository
    maven("https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases")
}

Configure Java Version

Modify the Java version of Kotlin in your project's build.gradle.kts to 17 or above.

Kotlin DSL

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
}

tasks.withType<KotlinJvmCompile>().configureEach {
    compilerOptions {
        jvmTarget.set(JvmTarget.JVM_17)
    }
}

Features Overview

The entire project is divided into multiple modules, these modules can exist independently of each other or depend on each other, you can choose the modules you want to introduce as dependencies and apply them to your project.

You can click on the corresponding modules below to view detailed functionality introductions.

Version Notes

Starting from 1.1.0, Android modules are released with a unified version, so in most cases you only need to care about the same major version, and you can also directly refer to android-bom below to use BOM for unified dependency version management.

Jetpack Compose modules currently still keep independent versions, because some modules are still in the Alpha stage and their release cadence is not forced to stay in sync with their submodules.

For details, please see the changelog.

Android

• android-bom
• ui-component
• ui-component-adapter
• ui-extension
• system-extension
• permission-extension

Jetpack Compose

• compose-extension
• compose-multiplatform

Demo

You can find some samples here to view the corresponding demo project to better understand how these functions work and quickly select the functionality you need.

Currently, the demo functionality is not yet complete, and may be gradually improved in the future.

But you can directly read the existing documents, which are sufficient to introduce related functions.

If you are using Jetpack Compose, you can refer to Flexi UI.