# AUI
**Repository Path**: zqhcoding/aui
## Basic Information
- **Project Name**: AUI
- **Description**: A general-purpose UI framework for the ALang language.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-11-09
- **Last Updated**: 2026-11-20
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README

# AUI
> 基于 ALang 语言的跨介质 UI 框架:一份组件树,覆盖终端、桌面与浏览器
AUI 用同一份 ALang 组件树覆盖三种介质:终端、桌面原生窗口与浏览器。组件将绘制意图录制成介质无关的 Draw List,由三条栅格化管线分别消费:终端将其落为字符格并按行差分输出,桌面与 Web 渲染为像素。介质间的能力差异由 Tier 模型描述:终端能近似呈现的效果采用预先设计的替身,无法呈现的能力在装配期直接报错,全部替身与限制均记录在文档中。
English version: [README.en.md](./README.en.md)
## 特性
- 一份组件树覆盖三种介质:终端(默认后端)、桌面原生窗口(AppKit,Windows/Linux 平台层在路线图上)和浏览器(WebSocket 直连或桌面桥窗口),业务代码不需要改动;
- 五层单向架构:组件、渲染/布局、核心能力、介质后端、原生模块,依赖只向下;
- 事件驱动,无轮询:输入阻塞等待在系统读取或介质泵上,主循环休眠至事件到达或帧截止;
- 差分渲染:终端按行差分编码 ANSI 后单次写语句输出,桌面按脏区增量提交,Web 按帧下发 JSON 指令;
- 60 多个组件,覆盖容器、显示、输入、选择、图表、数据网格、表单、对话框、文件选择、图片、菜单、撤销与翻页,含虚拟化列表和代码编辑器;
- 能力差异由 BackendCaps 快照、Tier A/B/C 分层与 RequiredCaps 装配门禁描述:缺失的能力在启动时报错,不做静默降级;
- 三层测试体系:组件单测、渲染契约、端到端测试(终端介质用真实伪终端驱动,各介质另有 headless 车道)。
## 快速开始
要求:[ALang](../alang) 解释器 `al` 与 C/C++ 工具链。
```bash
# 1. 构建全部原生模块(文本度量 / 差分 / 图像 / 合成器 / 平台层 / 桥 / 大文件)
bash build.sh
# 2. 跑一个样例(ctrl+d 退出)
AL_MODULE_PATH=$PWD/native/lib al examples/display.al
```
换介质只改装配那一行;三种介质的可运行入口:
```bash
AL_MODULE_PATH=$PWD/native/lib al examples/gui_smoke.al # 桌面窗口(约 4s 自退)
AL_MODULE_PATH=$PWD/native/lib al examples/web_smoke.al # 浏览器 WebSocket(打印入口 URL,6s 自退)
AL_MODULE_PATH=$PWD/native/lib al examples/webview_smoke.al # 桌面桥窗口(约 10s 自退)
```
21 个可运行样例在 `examples/`,每组件族一个,源码即文档。
## 组件一览
| 族 | 组件 |
|---|---|
| 容器 | Panel · Box · Collapsible · ScrollView · GroupBox · Accordion · Sash · Paned · Splitter |
| 显示 | Label · Paragraph · ProgressBar · Sparkline · Divider · EmptyState · StatusBar · Spinner · Toast |
| 输入 | TextInput · NumberInput · MaskedInput · TextArea · Checkbox · Button · RadioGroup · Switch |
| 选择 | ListView · Table · TabBar · TreeView · CheckboxTree · Dropdown · Select · Menu · MenuBar |
| 数据 | Slider · BarChart · LogView · CodeView · CodeEditor · DataGrid · VirtualList |
| 表单/对话框 | Form · ModalContainer · ConfirmDialog · Alert · Prompt · Backdrop · DialogWindow |
| 导航/动作 | Breadcrumb · Toolbar · ContextMenu |
| 文件 | DirectoryTree · FilePickerDialog |
| 图片 | ImageWidget(kitty 透传 / sixel / 真彩半格块 / 盲文点阵 opt-in / ASCII 降级) |
| 服务 | AutoComplete · TooltipHost · HelpOverlay · UndoManager · Pager |
## 文档
| 文档 | 内容 |
|---|---|
| [用户手册](docs/manual/用户手册.md) | 安装、快速上手、核心概念、全组件参考(含渲染快照)、跨介质指南、FAQ |
| [User Guide (EN)](docs/manual/user-guide.md) | 英文版手册 |
| [架构总纲 AUI-00](docs/design/AUI-00-架构总纲.md) | 多介质架构、模块耦合图、并发模型、ADR、依赖规则、路线图 |
| [后端 SPI 与能力模型 AUI-01](docs/design/AUI-01-后端SPI与能力模型.md) | 全介质后端契约面、BackendCaps、Tier A/B/C、RequiredCaps 门禁 |
| [介质中立层规范 AUI-02..08](docs/design/) | 核心/事件/渲染/布局/组件/应用内核/测试各层详细规格 |
| [介质后端规范 AUI-10..12](docs/design/) | 终端 / 桌面平台 / Web 三个对等后端的专项规格 |
| [ALang 能力需求 AUI-09](docs/design/AUI-09-ALang能力需求清单.md) | 语言/库分工决议与需求 intake |
| [FreeLoop 迁移方案 AUI-13](docs/design/AUI-13-FreeLoop迁移方案.md) | 首个下游消费者的迁移路径 |
| [组合键投递差异 AUI-14](docs/design/AUI-14-组合键投递差异.md) | legacy 终端键位物理可达性参考 |
## 运行测试
```bash
bash tests/run.sh # 三层套件(L1 单测 + L2 契约 + L3 端到端)
bash tests/coverage_check.sh # 规格接口矩阵覆盖门禁
bash tests/function_coverage_check.sh # 函数级覆盖门禁(套件末尾 strict 强制)
```
## 状态
全部功能通过完整测试套件验证(120 个测试文件);终端介质功能完整,桌面介质目前提供 macOS 平台层(Windows/Linux 在规划中),Web 介质支持浏览器直连与桌面桥窗口;下游项目 FreeLoop 正在迁移至 AUI,以替代其原有的终端界面层。