Kuikly is a comprehensive cross-platform solution for UI and logic based on Kotlin multi-platform. It was launched by Tencent's company-level Oteam in the front-end field. It aims to provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. Currently supported platforms:
- Android
- iOS
- HarmonyOS
- Web (Open-source in Q2)
- Mini Programs (Open-source in Q2)
Since its launch, Kuikly has gained wide recognition from the business. It has been used by many products such as QQ, QQ Music, QQ Browser, Tencent News, Sogou Input Method, MyApp Hub(Tencent's app store), WeSing, Kugou Music, Kuwo Music, Tencent Self-selected Stock, ima.copilot, Weishi, etc.
- Cross-platform: Kotlin-based implementation ensuring consistent operation across multiple platforms - one codebase, five platforms
- Native performance: Generates platform-native binaries (.aar/.framework/.so)
- Native development experience: Native UI rendering, native toolchain support, Kotlin as primary language
- Lightweight: Minimal SDK footprint (AOT mode: ~300KB for Android, ~1.2MB for iOS)
- Dynamic capability: Supports compilation into dynamic deliverables
- Multiple paradigms: Supports both declarative & reactive programming, with self-developed DSL and Compose DSL
.
├── core # Cross-platform module implementing core capabilities like responsive UI, layout algorithms, Bridge communication, etc.
├── src
├── commonMain # Shared cross-platform code, defining cross-platform interfaces
├── androidMain # Android platform implementation (outputs aar)
├── jvmMain # Generic JVM platform code (no Android APIs, outputs jar)
├── iosMain # iOS platform implementation (outputs framework)
├── ohosArm64Main # Ohos platform implementation（outputs so）
├── core-render-android # Android platform renderer module
├── core-render-ios # iOS platform renderer module
├── core-render-ohos # HarmonyOS platform rendering module
├── core-annotations # Annotations module, defining business annotations like @Page
├── core-ksp # Annotation processing module, generates Core entry files
├── buildSrc # Build scripts for compilation, packaging, and artifact splitting
├── demo # DSL example code
├── androidApp # Android host shell project
├── iosApp # iOS host shell project
├── ohosApp # Ohos host shell project
├── compose # Cross-platform module implementing Compose UI, layout, and Kuikly bridging capabilities
├── src
├── commonMain # Shared cross-platform code, including Compose UI components, layout and event handling
├── androidMain # Android platform specific implementation
└── nativeMain # iOS and HarmonyOS platform specific implementationNote: The Compose directory contains cross-platform source code based on Jetpack Compose 1.7.3 version. We have made necessary modifications and adaptations to the original Compose code to support Kuikly framework's rendering requirements. Some unnecessary features have been commented out to facilitate future upgrades. To ensure stable feature support and avoid conflicts with official code, we have changed the package name from
androidx.composetocom.tencent.kuikly.compose. The original Compose code is from JetBrains Compose Multiplatform.
- iOS 12.0+
- Android 5.0+
- HarmonyOS Next 5.0.0(12)+
- Kotlin 1.3.10+
Refer to Environment Configuration
-
if your Android Studio Version >= (2024.2.1) Please switch your Gradle JDK Version to JDK17 (this Version default Gradle JDK is 21, it incompatible with the configuration used by the project)
Android Studio -> Settings -> Build,Execution,Deployment -> Build Tools -> Gradle -> Gradle JDK
-
DevEco Studio(API Version >= 15)(You can check the API Version through【 DevECo Studio -> Help -> About HarmonyOS SDK 】)
-
JDK17
Ensure environment preparation is complete before building:
- Open
KuiklyUIroot directory inAndroid Studioand sync project - Select androidApp configuration, then Run 'androidApp'
Ensure environment preparation is complete before building:
- Navigate to
iosAppdirectory - Execute
pod install --repo-update - Open
KuiklyUIroot directory in Android Studio and sync project - Select iOSApp configuration, then Run 'iOSApp'
Alternatively, open KuiklyUI/iosApp in Xcode and Run
Note: The iosApp project will execute the KMP script when compiling. If you encounter an error with the script read and write file permissions, you need to set
User Script SandboxingtoNoinXcode -> Build Setting.
Ensure environment preparation is complete before building:
- In
KuiklyUIroot director Run kuikly Ohos product compile script,./2.0_ohos_test_publish.sh - Open
KuiklyUI/ohosAppin DevEco Studio and sync project - Connect to Ohos Phone or start the Ohos Emulator, and perform a signature operation
File -> Project Structure -> Signing Configs - Use DevEco Studio Run
entry, Run OhosApp
Notes: kuikly Ohos product only supports Mac compilation, Windows can use the compiled ohos product to run Ohos APP.
The KuiklyUI directory contains Gradle configurations for various Kotlin versions:
Naming convention: x.x.xx.gradle.kts (default uses Kotlin 2.0.21)
Test publishing scripts for each version are available as x.x.xx_test_publish.sh for building local artifacts.
Note: Kotlin 1.3.10/1.4.20 require JDK11
After successful build on any platform, you can modify Core, Render, and Demo to experience Kuikly development.
We welcome all developers to submit issues or PRs for Kuikly. Please review our Contribution Guide before contributing.
All project participants are expected to adhere to our Code of Conduct. Participation constitutes agreement to these terms.
- Special thanks to the first batch of contributors tom(邱良雄), kam(林锦涛), and watson(金盎), who not only pioneered the incubation and exploration of the Kuikly cross-platform solutions in the frontend field, but also were the first to implement them in the QQ business.
- Thanks to the following core contributors for the continuous construction, maintenance, development and optimization of
Kuikly:
tom kam watson rocky jonas ruifan pel layen bird zealot zhenhua vinney xuanxi arnon alexa allens eason
Scan the QR codes below to follow our latest updates or contact us for inquiries.