AGenUI is a high-performance A2UI SDK for building native generative UI experiences across iOS, Android, and HarmonyOS.
Official Website · Quick Start · API Reference · Contributing
English | 中文
This project is under active development and evolving rapidly. Contributions, feedback, and discussions are warmly welcome.
AGenUI is an A2UI SDK that simultaneously supports iOS, Android, and HarmonyOS. Built on and fully implementing the A2UI v0.9 protocol open-sourced by Google, it renders the streaming data of LLM-generated interactive UI in real time on mobile devices. Under the hood, it is powered by a cross-platform shared C++ core engine, while the three-platform rendering engines consume the component protocol dispatched by the core engine and perform drawing using native system capabilities.
AGenUI leverages native system UI capabilities to render interactive cards, forms, lists, images, media players, and more, delivering a high-performance, smooth user experience.
- Real-time streaming rendering — structured component descriptions are generated by the LLM, arrive incrementally, and update in real time
- High performance — native rendering on iOS, Android, and HarmonyOS, maintaining a 120 fps refresh rate in core scenarios such as page scrolling
- 22 built-in components — 18 A2UI protocol components + 4 SDK extension components
- Custom component API — register and extend native components via the custom component API, so the LLM can emit component descriptions by component name
- Function Call integration — register client-side tools/functions that the LLM can invoke on demand
- Design Token & theming — unified Design Token system and theme modes across all three platforms
- Light / Dark mode — built-in light/dark appearance switching
AGenUI adopts a shared C++ core engine + three-platform component rendering engines design. The C++ layer implements capabilities shared across all three platforms, including streaming data parsing, virtual component tree management, render data caching, theme/style resolution, and component change diffing. The C++ layer synchronizes the parsed component protocol to the three-platform rendering engines to trigger drawing.
| Path | Contents |
|---|---|
core/ |
C++ core engine — parser, differ, layout, Function Call framework |
core/include/ |
Public C++ API consumed by platform bridging layers |
platforms/ios/ |
iOS component renderer + Objective-C bridge |
platforms/android/ |
Android component renderer + JNI bridge |
platforms/harmony/ |
HarmonyOS component renderer + NAPI bridge |
playground/ |
Three-platform demo apps for development & debugging |
scripts/ |
Build scripts for each platform |
The following 18 components implement the A2UI protocol specification and are supported on all three platforms.
| Component | Description |
|---|---|
Text |
Styled text with variants (h1–h5, body, caption, etc.) |
Image |
Network image with scale modes and rounded corners |
Icon |
Icon rendered via Unicode / SVG mapping |
Divider |
Horizontal or vertical separator |
Video |
Native video player with seek and auto-hiding controls |
AudioPlayer |
Audio player with progress bar |
Button |
Tappable button that triggers Action events |
Row |
Horizontal flex container |
Column |
Vertical flex container |
Card |
Shadowed card container |
List |
Scrollable list with static or template-driven children |
Tabs |
Tab bar with switchable panels |
Modal |
Native dialog overlay |
TextField |
Text input with optional validation |
CheckBox |
Boolean toggle |
Slider |
Numeric range input |
ChoicePicker |
Single / multi-select picker |
DateTimeInput |
Date and time picker |
The following 4 components are bundled with the SDK but are not part of the A2UI protocol specification.
| Component | Description |
|---|---|
Table |
Data table with Yoga sub-layout |
Carousel |
Image / content carousel |
Web |
Embedded WebView |
RichText |
HTML rich text rendering |
The following 3 components are registered and applied in the Playground to demonstrate integrating custom components via the API.
| Component | Description |
|---|---|
Chart |
Bar, line, and pie charts |
Markdown |
Markdown rendering with streaming support |
Lottie |
Lottie animation playback |
You can register your own components at runtime using the same API — see the Quick Start section.
The repository root includes agenui_catalog.json, a self-contained (freestanding) Catalog JSON Schema file conforming to the A2UI v0.9 specification. All external $refs have been inlined — it can be used standalone with no external dependencies.
Coverage:
- 25 components: 18 A2UI protocol standard components + 4 SDK built-in extension components (
Table,Carousel,Web,RichText), plus 3 Playground example components (Chart,Markdown,Lottie) - 14 functions: covering validation, formatting, logical operators, and URL navigation
- Shared type definitions: includes all A2UI v0.9 standard types, as well as
Styles(general style properties) andTextStyles(text-specific style properties) — both extended by AGenUI
How to use:
When integrating an LLM Agent, supply this file's content or its hosted URL as the catalogId in the supportedCatalogIds field of A2UI ClientCapabilities. The Agent will use this Schema as a constraint to generate strictly conformant A2UI JSON messages, ensuring the renderer correctly parses and renders all dispatched UI components.
The skills/a2ui-generation/ directory ships a standalone A2UI generation Skill that can be mounted into any Agent that supports the Agent Skills mechanism (e.g. Claude Code, Codex, Qoder). It guides the LLM — via the Skill's built-in design rules and constraints — to turn a natural-language query into A2UI protocol messages (updateComponents / updateDataModel) that AGenUI can render directly.
Register skills/a2ui-generation/ as a Skill in your Agent, then describe the UI you want through a query. The Skill drives the LLM to emit A2UI v0.9–conformant JSON protocol.
- Default shape: a single Card, focused on the essential information.
- Custom layout & styling: your query can explicitly request other shapes (full page, list, table, etc.) or specific visual requirements (palette, spacing, font sizes, theme). When your explicit instruction conflicts with the Skill's defaults, the explicit instruction wins.
Different LLMs may produce somewhat different results when generating A2UI output. We recommend trying a few models against your own scenarios and picking the one that fits best.
| Platform | Toolchain |
|---|---|
| Android | Android Studio Hedgehog+, NDK 27.3.13750724, API 35 SDK, JDK 11 |
| iOS | Xcode 15+, CocoaPods, CMake |
| HarmonyOS | DevEco Studio 4.0+, ohpm |
All build scripts live in the scripts/ directory. The C++ engine in core/ is compiled automatically — no separate preparation step is needed.
Android
# Release AAR (default)
./scripts/android/build.sh
# Debug AAR
./scripts/android/build.sh --debug
# Publish to local Maven (~/.m2)
./scripts/android/build.sh --publish-local
# Clean before building
./scripts/android/build.sh --cleanThe AAR is written to dist/android/release/.
iOS
# XCFramework (Release, default)
./scripts/ios/build.sh
# Single-arch Framework, Debug
./scripts/ios/build.sh -t framework -c Debug
# Force pod install then build
./scripts/ios/build.sh --pod-installHarmonyOS
# HAR package (Release, default)
./scripts/harmony/build.sh
# Debug build
./scripts/harmony/build.sh --mode debug
# Custom output directory
./scripts/harmony/build.sh -o /path/to/outputA standalone Playground project is provided for each platform under playground. You can open and run any Playground project to experience the full A2UI component rendering. Each Playground references the AGenUI source code directly, so breakpoint debugging is supported.
Android Playground
- Open
playground/android/with Android Studio - Let Gradle install dependencies and index the source files
- Switch dependency mode via
gradle.properties:
# Source mode: changes to the C++ engine and the Android renderer take effect immediately
agenui.sdk.source=true
# AAR mode: no longer references source; consumes the pre-packaged SDK build (recommended only when debugging the Playground itself)
agenui.sdk.source=false
iOS Playground
- Enter the
playground/ios/Playgrounddirectory - Run
pod installto install dependencies and generate the Xcode workspace; on success,Playground.xcworkspacewill be generated underplayground/ios/Playground - Open
Playground.xcworkspace, pick a simulator, and build & run
Playground.xcworkspace already contains both the AGenUI source and the Playground target
HarmonyOS Playground
- Open the
playground/harmonydirectory with DevEco Studio - Let it install dependencies and index the source files
- Pick a simulator, and build & run
The project references platforms/harmony/agenui/ via srcPath, so any change to the AGenUI source is automatically picked up by the next build
For details on building the source into a directly integrable artifact (see Building from Source) and integrating it into your application, please refer to:
SDK installation & usage guide: Quick Start
Complete SDK API reference: API Reference
Contributions of all kinds are welcome — bug fixes, new components, platform improvements, documentation, and test coverage.
Before submitting a pull request, please read CONTRIBUTING.md for the full workflow, code style guidelines (C++, Swift, and Java follow the Google Style Guide; ArkTS follows the OpenHarmony conventions), and the PR checklist.
Quick summary:
- Fork the repo and create a branch from
main:fix/123-my-fixorfeat/my-feature - Make your changes and add tests where appropriate
- Build and test locally on the affected platform(s)
- Open a PR against
mainwith a clear description of what and why - At least one maintainer approval is required before merging
For larger changes — new platform support, significant engine refactors, new component categories — please open an issue first to align on the approach before writing code.
- GitHub Issues: bug reports and feature requests
- GitHub Discussions: Q&A and general discussions
- Email: tengjixiang.ttjx@alibaba-inc.com
- DingTalk Group: Chinese community
- WeChat Group: Chinese community
| DingTalk Group | WeChat Group |
|---|---|
 |
 |
AGenUI is released under the Apache License, Version 2.0.