flutter_quill

本项目为 Flutter Quill 在 OpenHarmony 平台的适配说明。

1. 安装与使用

1.1 安装方式

进入到工程目录并在 pubspec.yaml 中添加以下依赖：

pubspec.yaml

...

dependencies:
  flutter_quill:  
    git:
      url: https://gitcode.com/CPF-Flutter/fluttertpc_flutter_quill.git
      ref: TAG #根据下面框架版本选择TAG
      #ref: 11.4.1-ohos.1.0.0
...

TAG 版本对应表

Flutter 框架版本	TAG	分支
3.27	11.4.1-ohos.1.0.0	master
3.35	11.4.1-ohos.1.0.0	master

执行命令

flutter pub get

1.2 使用案例

使用案例详见 example。

2. 约束与限制

2.1 兼容性

在以下版本中已测试通过:

1. Flutter: 3.27.5-ohos-0.0.1; SDK: 5.0.0(12); IDE: DevEco Studio: 5.1.0.828; ROM: 5.1.0.130 SP8;
2. Flutter: 3.35.8-ohos-0.0.1; SDK: 6.0.1(21); IDE: DevEco Studio: 6.0.1.260; ROM: 6.0.0.120 SP6;

2.2 权限要求

2.2.1 在 entry 目录下的module.json5中添加权限

[Tips] 权限申请参考

打开 entry/src/main/module.json5，添加：

...
"requestPermissions": [
+  {
+    "name": "ohos.permission.READ_PASTEBOARD"
+  },
+  {
+    "name": "ohos.permission.WRITE_MEDIA"
+  }
]

3. API

Flutter Quill API

Name	Description	Type	Input	Output	ohos Support
QuillEditor	富文本编辑器组件	class	QuillController, ScrollController, FocusNode, 等	Widget	yes
QuillSimpleToolbar	简易工具栏组件	class	QuillController, 配置项（按钮、样式等）	Widget	yes
QuillController	文档控制器（编辑状态与 Delta 管理）	class	Document, Selection, 历史记录配置等，依赖quill_native_bridge，参考readme [README.OpenHarmony_CN]	Controller	yes

---

4. 遗留问题

5. 其他

6. 开源协议

本项目基于 MIT License。