diff --git a/frameworks/bridge/arkts_frontend/koala_projects/arkoala/framework/README.md b/frameworks/bridge/arkts_frontend/koala_projects/arkoala/framework/README.md index 97335e655bc69048813c47c69e45862d720de454..b7b1f0bc0aed26c58d21c1891b7b5315f7c5675b 100644 --- a/frameworks/bridge/arkts_frontend/koala_projects/arkoala/framework/README.md +++ b/frameworks/bridge/arkts_frontend/koala_projects/arkoala/framework/README.md @@ -1,26 +1,79 @@ -## Cross-compilation for Windows on Linux host -### 1. Getting Windows headers and libs -```bash -/* blue zone */ -KOALA_BZ=1 OPENLAB_USERNAME="your_login" OPENLAB_PASSWORD="your_password" npm run prepare:wincrt:bz -/* yellow and green zone */ -npm run prepare:wincrt:yz -``` -if you using another windows headers export WINCRT_HOME +# JS UI Framework -### 2. Installing LLVM 14 +## 简介 +本项目是一个JS UI框架,用于构建用户界面。它包含多个组件和能力,支持在不同设备上运行,包括手机、平板、TV、可穿戴设备等。 -Configure script looks for `clang-cl`, `llvm-lib` and `ldd-link` in `$LLVM_HOME/bin`, `/usr/lib/llvm-14/bin` or `%ProgramFiles%\LLVM\bin`, and system path +## 目录结构 +- **adapter/ohos**: 适配OHOS系统的源码 +- **advanced_ui_component**: 高级UI组件实现,如ArcButton, ArcSlider, Chip, Dialog等 +- **component_ext**: 组件扩展功能,如ArcAlphabetIndexer, ArcList, ArcScrollBar等 +- **examples**: 示例代码,展示如何使用框架,如Dialog_C, Image, ImageAnimator等 +- **build**: 构建脚本和配置 -```bash -sudo apt update -sudo apt install clang-14 lldb-14 lld-14 clang-tools-14 -``` +## 使用场景 +- 开发跨设备应用 +- 创建复杂的UI交互 +- 支持手势操作、动画、网络请求、剪贴板功能等 +- 实现多窗口、拖拽、AI文本分析等功能 -### 3. Run configure and compile -```bash -npm run configure:native-panda-windows-x64 -npm run compile:native-panda-windows-x64 -``` \ No newline at end of file +## 可用组件 +- **ArcButton**: 圆弧按钮组件 +- **ArcSlider**: 圆弧滑动组件 +- **Chip**: 可交互的小型组件 +- **SegmentButton**: 分段按钮组件 +- **ToolBar**: 工具栏组件 +- **TreeView**: 树形结构组件 +- **FullScreenLaunchComponent**: 全屏启动组件 +- **MovingPhoto**: 动态照片组件 + +## 相关仓 +- **ArkUI**: 鸿蒙系统中的声明式UI框架 +- **OHOS::Ace**: 框架核心功能 +- **OHOS::Rosen**: Rosen子系统用于窗口管理 +- **OHOS::AAFwk**: Ability框架 +- **OHOS::AppExecFwk**: 应用框架执行模块 +- **OHOS::Media::MediaPipe**: 媒体管道模块 +- **OHOS::HiviewDFX::HiTraceId**: 分布式跟踪ID模块 + +## 构建方式 +- 使用`BUILD.gn`文件进行GN构建 +- 通过`ace_engine.para.dac`等配置文件配置参数 +- 用`build/tools`中的工具进行资源处理和字节码生成 + +## 测试 +- 包含单元测试和集成测试 +- 使用`gtest`框架进行C++测试 +- 使用`@ohos/hypium`进行ETS测试 + +## 调试和分析 +- 支持HiTrace链路追踪 +- 支持UI性能监控 +- 包含布局检查器和内存回收检测 + +## 版本历史 +- **Beta4**: 初始版本 +- **Beta5**: 添加新特性 +- **Release**: 稳定版本 + +## 其他特性 +- 支持暗光模式 +- 支持多语言 +- 支持手势操作 +- 支持AI文本分析 +- 支持震动反馈 + +## 依赖库 +- **libace_engine_ark.z.so**: 核心引擎库 +- **libark_inspector.z.so**: 调试检查库 +- **libai_text_analyzer_innerapi.z.so**: AI文本分析库 +- **libsystemshare_innerkits.z.so**: 系统共享库 + +## 开发者支持 +- 提供`ace_view_ohos.h`用于视图管理 +- 提供`ace_translate_manager.h`用于翻译管理 +- 提供`event_dispatcher.h`用于事件分发 + +## 许可证 +本项目遵循Apache 2.0协议。 \ No newline at end of file