快速开始

当前支持的平台: Android / Desktop(JVM) / iOS / WasmJs / Js / macOS(Native)

注意

此库处于实验阶段，API 可能会在未来版本中变更而不另行通知

添加依赖

要在您的项目中使用 Miuix，请按照以下步骤添加依赖：

Gradle (Kotlin DSL)

1. 在根目录的 settings.gradle.kts 添加（正常情况应已包含）：

repositories {
    mavenCentral()
}

2. 检查 Maven Central 当前最新版本：

3. 在项目的 build.gradle.kts 中添加依赖：

• 在 Compose Multiplatform 项目目录的 build.gradle.kts 中：

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("top.yukonga.miuix.kmp:miuix:<version>")
        }
    }
}

• 在 Android Compose 项目目录的 build.gradle.kts 中：

dependencies {
    implementation("top.yukonga.miuix.kmp:miuix-android:<version>")
}

• 在其他常规项目中使用，则只需要根据需要添加对应平台后缀的依赖即可：

implementation("top.yukonga.miuix.kmp:miuix-android:<version>")
implementation("top.yukonga.miuix.kmp:miuix-iosarm64:<version>")
implementation("top.yukonga.miuix.kmp:miuix-iosx64:<version>")
implementation("top.yukonga.miuix.kmp:miuix-iossimulatorarm64:<version>")
implementation("top.yukonga.miuix.kmp:miuix-macosx64:<version>")
implementation("top.yukonga.miuix.kmp:miuix-macosarm64:<version>")
implementation("top.yukonga.miuix.kmp:miuix-desktop:<version>")
implementation("top.yukonga.miuix.kmp:miuix-wasmjs:<version>")
implementation("top.yukonga.miuix.kmp:miuix-js:<version>")

基本用法

应用 Miuix 主题

@Composable
fun App() {
    val colors = if (isSystemInDarkTheme()) {
        darkColorScheme()
    } else {
        lightColorScheme()
    }
    MiuixTheme(
        colors = colors
    ) {
        // Other Content...
    }
}

使用 Miuix 脚手架

Scaffold(
    topBar = {
        // TopBar
    },
    bottomBar = {
        // BottomBar
    },
    floatingActionButton = {
        // FloatingActionButton
    }
) {
    // Content...
}

注意

Scaffold 组件为跨平台提供了一个合适的弹出窗口的容器。SuperDialog、SuperDropdown、SuperSpinner、ListPopup 等组件都基于此实现弹出窗口，因此都需要被该组件包裹。

API 文档

• 查看 API 文档，此文档使用 Dokka 生成，包含了所有 API 的详细信息。