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