Super Editor 是一个高度可配置、可组合且可扩展的 Flutter 文本编辑器和文档渲染器。它使开发者能够构建支持自定义格式、插件和动态内容渲染的富文本编辑体验。设计上注重灵活性,允许对编辑行为、样式和交互模式进行深度定制。适用于需要高级文档处理功能的应用程序,如笔记应用、协作编辑器或内容管理系统。专为性能和可扩展性而设计,支持 Android 和 iOS 平台。
适合场景
在笔记应用中进行富文本编辑
协作文档编辑
自定义 markdown 或 HTML 渲染
动态内容组合
可扩展的文本输入UI组件
基于文档的应用程序界面
主要特点
高度可组合的架构
对自定义插件和扩展的支持
可配置的文本格式化和样式
跨平台兼容性(Android、iOS)
内置对富文本和文档渲染的支持
可扩展的事件和操作系统
适合对象
开发高级文本编辑器的开发者
需要可自定义文档工作流的团队
需要丰富文本和媒体集成的应用程序
具有复杂内容建模需求的项目
寻求模块化编辑器解决方案的Flutter开发者
使用建议
由于可组合性导致的学习曲线更陡峭
对于复杂用例,需要仔细的状态管理
可能需要额外设置才能使用高级功能,如协作
性能取决于实现的复杂性
针对特定用例的有限开箱即用模板
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
Open source, configurable, extensible text editor and document renderer for Flutter.
Super Editor works with any backend. Plug yours in and go!
Super Editor was initiated by Superlist and is implemented and maintained by the Flutter Bounty Hunters, Superlist, and the contributors.
A Note on Releases (June, 2024):
We've been busy at work on core editor improvements like undo/redo, a stable editor pipeline, and useful editor reactions. These APIs have evolved a lot, so we haven't cut a standard release in a long time. We're still evolving those APIs right now.
Rest assured, Super Editor and the other projects in this repo are under regular development. We're still here and working hard.
We're now starting to publish developer releases of Super Editor so that the community can see what we've been working on.
As a reminder, your project doesn't need to use Pub to use Super Editor. You can depend directly on this GitHub repository to keep up with the latest changes. Please check the section below about our Git branches.
A Note on Branches:
Do you use Flutter's stable branch? Be sure to checkout super_editor's stable branch, for compatibility. Do you use Flutter's master branch? Be sure to checkout super_editor's main branch, for compabitility.
You might notice that this is a mono-repo, which includes multiple projects. That's because we're not just building an editor. We're building a document editing toolkit. In fact, we're revolutionizing all text layout and editing with Flutter! Check out some of our supporting projects.
Mono-repo Versioning
If you have compilation errors when using the GitHub version of super_editor, try overriding dependencies for the other packages in this mono-repo, e.g., super_editor_markdown, super_text_layout, and attributed_text. This project often makes changes to multiple packages within the mono-repo, which requires that you use the latest main or stable version of every package.
You can override your dependencies as follows:
dependency_overrides:super_editor:git:url:https://github.com/superlistapp/super_editorpath:super_editorref:stable# or "main"super_editor_markdown:git:url:https://github.com/superlistapp/super_editorpath:super_editor_markdownref:stablesuper_text_layout:git:url:https://github.com/superlistapp/super_editorpath:super_text_layoutref:stableattributed_text:git:url:https://github.com/superlistapp/super_editorpath:attributed_textref:stable