快速开始

集成 BetterAndroid 到你的项目中。

项目要求

项目需要使用 Android StudioIntelliJ IDEA 创建且类型为 Android 或 Kotlin Multiplatform 项目并已集成 Kotlin 环境依赖。

配置存储库

BetterAndroid 的依赖发布在 Maven Central 和我们的公共存储库中,你可以使用如下方式配置存储库。

我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言并推荐使用 SweetDependency在新窗口中打开 来管理依赖。

SweetDependency (推荐)

在你的项目 SweetDependency 配置文件中配置存储库。

repositories:
  google:
  maven-central:
  # (可选) 你可以添加此 URL 以使用我们的公共存储库
  # 当 Sonatype-OSS 发生故障无法发布依赖时,此存储库作为备选进行添加
  # 详情请前往:https://github.com/HighCapable/maven-repository
  highcapable-maven-releases:
    # 中国大陆用户请将下方的 "raw.githubusercontent.com" 修改为 "raw.gitmirror.com"
    url: https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases

传统方式

在你的项目 build.gradle.kts 中配置存储库。

repositories {
    google()
    mavenCentral()
    // (可选) 你可以添加此 URL 以使用我们的公共存储库
    // 当 Sonatype-OSS 发生故障无法发布依赖时,此存储库作为备选进行添加
    // 详情请前往:https://github.com/HighCapable/maven-repository
    // 中国大陆用户请将下方的 "raw.githubusercontent.com" 修改为 "raw.gitmirror.com"
    maven("https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases")
}

配置 Java 版本

在你的项目 build.gradle.kts 中修改 Kotlin 的 Java 版本为 17 及以上。

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
    kotlinOptions {
        jvmTarget = "17"
    }
}

功能一览

整个项目分为多个模块,这些模块可以互相独立存在,也可以互相依赖,你可以选择你希望引入的模块作为依赖应用到你的项目中。

你可以点击下方对应的模块前往查看详细的功能介绍。

项目模版

你可以使用我们提供的项目模版来快速创建一个集成了 BetterAndroid 依赖的项目。

Demo

你可以在 这里在新窗口中打开 找到一些示例,查看对应的演示项目来更好地了解这些功能的运作方式,快速地挑选出你需要的功能。

目前 Demo 功能尚未完善,可能在后期会逐渐完善。

不过你可以直接阅读现有文档,它们已足够介绍相关功能。

如果你正在使用 Jetpack Compose,你可以参考 Flexi UI在新窗口中打开