一个为 Android、iOS 和 Web 提供富文本 HTML 编辑器的 Flutter 包,由 Quill.js 库驱动。它提供现代化的所见即所得编辑体验,全面支持格式化、图片、链接和自定义 HTML 输出。非常适合需要跨平台强大内容创建和编辑功能的应用程序。该编辑器是开源的,并可通过简单的 pub add 命令无缝集成到 Flutter 项目中。
适合场景
内容管理系统
博客文章编辑器
用户生成内容表单
富文本消息应用
文档工具
主要特点
所见即所得编辑界面
支持 HTML 和富文本格式
图像和链接插入
跨平台兼容性(Android、iOS、Web)
开源且积极维护
适合对象
开发需要富文本的网页和移动应用的开发者
需要跨平台保持一致编辑体验的团队
需要可自定义富文本输入的应用
使用建议
需要了解 HTML 和 Quill.js 的概念
可能需要额外的样式以保持UI一致性
大型文档的性能影响
与纯 Flutter 解决方案相比,原生 Flutter 小部件集成有限
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
Quill Html Editor
Quill Html Editor is a powerful HTML rich text editor designed for Android, iOS, and Web platforms. It leverages the capabilities of the QuillJs library, an open-source WYSIWYG editor, to provide a feature-rich editing experience for modern web applications.
Features
Highly customizable Editor and Toolbar widgets.
Supports the Delta format, allowing you to set and retrieve content using setDelta and getDelta methods.
Enables seamless copy-pasting of rich text from other files or webpages.
The detached Toolbar can be placed anywhere on the page to suit your requirements.
Provides the flexibility to add custom buttons to the toolbar.
Supports embedding of images, videos, and insertion of tables.
Allows setting and retrieving text in both HTML and Delta formats.
Supports integration with Google Fonts for a wide range of font options.
Demo
To experience the capabilities of the Quill Html Editor, you can visit our Demo Page. Explore the editor's functionalities and see how it can enhance your web editing experience.
Screenshots
Documentation
See the API documentation for details on the following topics:
The ToolBar.scroll widget allows you to display the toolbar buttons in a single row or column, based on the specified direction parameter. By default, the direction is set to Axis.horizontal, which arranges the buttons in a single row.
To change the direction and display the buttons in a single column, you can provide the direction parameter as Axis.vertical. Here's an example:
In the above example, the ToolBar.scroll widget is used to display the toolbar buttons in a vertical arrangement.
Customizing Toolbar Buttons
The ToolBar widget allows you to customize the buttons that are displayed in the toolbar. By default, if the toolBarConfig parameter is not provided, all the toolbar buttons will be shown.
If you want to show only specific buttons, you can pass a list of ToolBarStyle types to the toolBarConfig parameter. For example:
In the above example, custom buttons with heart and add circle icons are added to the toolbar.
Feel free to customize the toolbar configuration and add custom buttons according to your requirements to enhance the editing experience with the Quill Html Editor.
Custom Fonts in Quill Html Editor
You can pass custom fonts to the text style in the quill_html_editor package by following these steps:
Define your custom font family in your Flutter project. You can use Google Fonts. Let's assume you want to use the 'Roboto' font family.
By following these steps, you can pass custom font styles to the text within the QuillHtmlEditor widget. The fontFamily property of the TextStyle allows you to specify the desired font family, such as 'Roboto' in this example.
To get the html string from editor
String? htmlText = await controller.getText();
To set the html string to editor
await controller.setText(text);
To get the text in delta format
await controller.getDelta();
To set the text in delta format
controller.setDelta(deltaMap);
To insert the html string to editor
/// index is optional/// If the index is not passed, the text will be inserted at the cursor positionawait controller.insertText(text, index: 10);
To clear the editor
controller.clear();
To enable editor
controller.enableEditor(true);
To disable editor
controller.enableEditor(false);
Todo
CustomStyleButton - Let the user add own icons to toolbar styles
Custom Color - Let the user add more Colors to the Color Picker
Custom FontSize - Let the user add custom font sizes, instead of just Small, Normal, Large & Huge
AsyncImagePickerButton - To share picked file to user, to upload it asynchronously and inserts the returned link into the editor
More examples for each available apis
MIT License
Copyright (c) 2022 Pavan Kumar Nagulavancha
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.