AppFlowy编辑器

一个高度可定制的富文本编辑器，适用于 Flutter

Discord • Twitter

主要特点

• 构建丰富、直观的编辑器
• 设计和修改不断扩展的可定制功能列表，包括
  • 组件（例如表单输入控件、编号列表和富文本小部件）
  • 快捷键事件
  • 主题
  • 菜单选项（即将推出！）
• 测试覆盖率以及AppFlowy核心团队和1000多名构建者的社区的持续维护

入门

将AppFlowy编辑器 Flutter包 添加到您的环境中。

flutter pub add appflowy_editor
flutter pub get

创建您的第一个编辑器

首先创建一个新的空AppFlowyEditor对象。

final editorState = EditorState.empty(); // an empty state
final editor = AppFlowyEditor(
    editorState: editorState,
);

您也可以从JSON对象创建编辑器，以配置您的初始状态。或者您可以 从Markdown或Quill Delta创建编辑器。

final json = ...;
final editorState = EditorState(Document.fromJson(data));
final editor = AppFlowyEditor(
    editorState: editorState,
);

注意：需要在MaterialApp小部件中分配 `localizationsDelegates` 参数

MaterialApp(
    localizationsDelegates: const [
        AppFlowyEditorLocalizations.delegate,
    ]，
);

为了了解AppFlowy编辑器的工作原理，请运行我们的示例

git clone https://github.com/AppFlowy-IO/appflowy-editor.git
flutter pub get
flutter run

自定义您的编辑器

自定义组件

请参阅我们关于自定义AppFlowy的文档，以详细讨论 自定义组件。

以下是一些组件自定义的示例

• 复选框文本演示了如何基于现有的富文本组件扩展新样式
• 图片演示了如何扩展新节点并渲染它
• 查看更多 富文本插件 的示例

自定义快捷键事件

请参阅我们关于自定义AppFlowy的文档，以详细讨论 自定义快捷键事件。

以下是一些快捷键事件自定义的示例

• BIUS演示了如何通过快捷键使文本加粗/斜体/下划线/删除线
• 粘贴HTML 让您了解如何通过快捷键处理粘贴的样式
• 需要更多示例？请查看 内部按键事件处理程序

词汇表

请参阅API文档。

贡献

贡献是开源社区成为学习、启发和创造的惊人场所的原因。您的任何贡献都将不胜感激。

请查看 CONTRIBUTING.md 以了解详情。

许可证

根据AGPLv3许可证分发。有关更多信息，请参阅 LICENSE。

GitHub

查看 Github