GearUI Kit

English | 简体中文

A Kotlin Multiplatform UI component library built on Kuikly.

• Coordinates: com.gearui:gearui-kit:1.0.0-beta2
• Available on Maven Central; 1.0.0-beta1 was the first public release (2026-08-15)
• Published artifacts: Android, iOS (arm64 / simulator arm64 / x64), JS (browser)
• Also builds for HarmonyOS (ohosArm64) through a separate configuration; not published to Maven Central
• Website: https://gearui.com
• License: BSD 3-Clause License

• Author: zoujiaqing
• Email: zoujiaqing@gmail.com

Captured from the sample app on an iPhone 17 Pro simulator.

Home (Chinese)	Home (English)	Settings (Light)	Settings (Dark)

Language and theme are switched at runtime from the settings page; every component follows both without any per-screen wiring.

72 components in 6 categories. Every one of them ships a demo page in the sample app.

The table above is generated from sample/.../config/ComponentConfig.kt by scripts/gen_component_index.py; a CI check fails when it goes stale.

Released on Maven Central. Declare the single root coordinate — Gradle reads the module metadata and resolves the per-target artifact (-android, -js, -iosarm64, …) for whatever you are compiling. Never depend on those directly.

repositories {
    mavenCentral()
}

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("com.gearui:gearui-kit:1.0.0-beta2")
        }
    }
}

First publish from the gearui-kit project to your local Maven repository:

./gradlew :gearui-kit:publishToMavenLocal

Then add it in your app project:

repositories {
    mavenLocal()
    mavenCentral()
}

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("com.gearui:gearui-kit:1.0.0-beta2")
        }
    }
}

dependencies {
    implementation(project(":gearui-kit"))
}

@Page("MainPage")
class MainPage : View() {
    @Composable
    // View mounts the App root (theme, i18n, overlays, safe area) for you.
    // Override themeMode() / themeSpec() to change it; do not call App() here.
    override fun Content() {
        MainPageContent()
    }
}

@Composable
private fun MainPageContent() {
    val colors = Theme.colors

    Column(
        modifier = Modifier
            .fillMaxSize()
            .background(colors.background)
            .padding(16.dp)
    ) {
        Button(
            text = I18n.strings.buttonConfirm,
            theme = ButtonTheme.PRIMARY,
            onClick = {}
        )
    }
}

Web runs through KuiklyUI's web renderer; the one demo that fails is Table, on a Kotlin/JS partial-linkage error in the sample's own demo file rather than in the component. See sample/jsApp/README.md.

HarmonyOS is supported and builds end to end — Kotlin/Native → CMake NAPI glue → ArkTS → an installable HAP carrying both libshared.so and libkuikly_entry.so. It cannot be a target of the normal build: the KuiklyUI artifacts carrying ohosArm64 are published against Kotlin 2.0.21-KBA-010, so ohos uses a parallel build configuration selected with -c settings.ohos.gradle.kts:

./gradlew -c settings.ohos.gradle.kts :sample:linkSharedDebugSharedOhosArm64

The HAP has not been launched on a device or emulator yet, so nothing about the UI is verified there — installing needs an emulator image and a signed package, both behind a Huawei developer account. See sample/ohosApp/README.md for the build steps and exactly what remains.

• Component layer path: gearui-kit/src/commonMain/kotlin/com/gearui/components
• Sample project: sample/

• For navigation, only the core entry is kept: Tabs (content switching).
• Accordion mode is unified into: Collapse.Accordion (no standalone Accordion component maintained).
• No synonymous wrapper components are kept, to avoid duplicate APIs and duplicate sample pages.

• Architecture overview: ARCHITECTURE.md
• Spec entry: docs/SPEC.md
• Releasing (maintainers): docs/RELEASING.md
• Web host: sample/jsApp/README.md
• HarmonyOS host: sample/ohosApp/README.md

Documentation is written in English first; *.zh-Hans.md files are the Chinese counterparts. Code comments are English only — see docs/SPEC_CI_MAPPING.md entry 18 for the check that enforces it.

# Build the library per platform
./gradlew :gearui-kit:compileDebugKotlinAndroid
./gradlew :gearui-kit:compileKotlinIosSimulatorArm64
./gradlew :gearui-kit:compileKotlinJs

# Run the sample
./gradlew :sample:installDebug                    # Android
./gradlew :sample:jsApp:jsBrowserDevelopmentRun   # Web, then open http://localhost:8081/

# HarmonyOS uses a parallel build configuration (unbuilt — see sample/ohosApp/README.md)
./gradlew -c settings.ohos.gradle.kts :sample:linkSharedDebugSharedOhosArm64

# Architecture guardrails — 18 checks, all runnable locally
for f in scripts/ci/check_*.sh; do "$f"; done

BSD 3-Clause License — see LICENSE.