Flutter Quill is a rich text editor and a Quill component for Flutter.

This library is a WYSIWYG (What You See Is What You Get) editor built for the modern Android, iOS, web and desktop platforms.

Check out our Youtube Playlist or Code Introduction to take a detailed walkthrough of the code base. You can join our Slack Group for discussion.

• 📸 Screenshots
• 📦 Installation
• 🛠 Platform Specific Configurations
• 🚀 Usage
• 💥 Breaking Changes
• 🔤 Input / Output
• ⚙️ Configurations
• 📦 Embed Blocks
• 🔄 Conversion to HTML
• 📝 Spelling checker
• ✂️ Shortcut events
• 🌐 Translation
• 🧪 Testing
• 🤝 Contributing
• 📜 Acknowledgments

Tap to show/hide screenshots

dependencies:
  flutter_quill: ^<latest-version-here>

OR

dependencies:
  flutter_quill:
    git:
      url: https://github.com/singerdmx/flutter-quill.git
      ref: v<latest-version-here>

The flutter_quill package uses the following plugins:

1. url_launcher to open links.
2. quill_native_bridge to access platform-specific APIs for the editor.
3. flutter_keyboard_visibility_temp_fork to listen for keyboard visibility changes.

All of them don't require any platform-specific setup.

Instantiate a controller:

QuillController _controller = QuillController.basic();

Use the QuillEditor, and QuillSimpleToolbar widgets, and attach the QuillController to them:

QuillSimpleToolbar(
  controller: _controller,
  configurations: const QuillSimpleToolbarConfigurations(),
),
Expanded(
  child: QuillEditor.basic(
    controller: _controller,
    configurations: const QuillEditorConfigurations(),
  ),
)

Dispose of the QuillController in the dispose method:

@override
void dispose() {
  _controller.dispose();
  super.dispose();
}

Check out Sample Page for more advanced usage.

• APIs marked with @experimental are subject to change or removal at any time and should be used with caution, as they may be altered even in minor versions.

• APIs marked with @internal and @visibleForTesting are not intended for public use and should be avoided entirely.

• The package:flutter_quill/flutter_quill_internal.dart expose internal APIs to be used by other related packages and should be avoided when possible.

We make every effort to ensure internal APIs are not exported by default. Use experimental features at your own discretion.

We recommend checking the CHANGELOG.md or release notes for each update to stay informed.

This library uses Quill Delta to represent the document content. The Delta format is a compact and versatile way to describe document changes. It consists of a series of operations, each representing an insertion, deletion, or formatting change within the document.

• Use _controller.document.toDelta() to extract the deltas.
• Use _controller.document.toPlainText() to extract plain text.

To save a document as a JSON:

final json = jsonEncode(_controller.document.toDelta().toJson());

To open the editor with an existing JSON representation that you've previously stored:

final json = jsonDecode(r'{"insert":"hello\n"}');

_controller.document = Document.fromJson(json);

• Quill Delta
• Quill Delta Formats
• Why Quill
• Quill JS Configurations
• Quill JS Interactive Playground
• Quill JS GitHub repo

The QuillSimpleToolbar and QuillEditor widgets are both customizable. Sample Page provides sample code for advanced usage and configuration.

• Using Custom App Widget
• Localizations Setup
• Font Size
• Font Family
• Custom Toolbar buttons
• Search

To use your own fonts, update your Assets folder and pass in fontFamilyValues. More details on this commit, this article and this.

The flutter_quill package provides an interface for all the users to provide their own implementations for embed blocks. Implementations for image, video, and formula embed blocks are proved in a separate package flutter_quill_extensions.

To see how to use the extension package, please take a look at the README of FlutterQuill Extensions

• Custom Embed Blocks
• Custom Toolbar

The following packages can be used:

1. vsc_quill_delta_to_html: To convert Delta to HTML.
2. flutter_quill_delta_from_html: To convert HTML to Delta.
3. flutter_quill_to_pdf: To convert Delta To PDF.
4. markdown_quill: To convert Markdown To Delta and vice versa.

This feature is currently not implemented and is being planned. Refer to #2246 for discussion.

We can customize some Shorcut events, using the parameters characterShortcutEvents or spaceShortcutEvents from QuillEditorConfigurations to add more functionality to our editor.

To see an example of this, you can check customizing_shortcuts

The package offers translations for the quill toolbar and editor, it will follow the system locale unless you set your own locale.

Open this page for more info

Take a look at flutter_quill_test for testing.

Notice that currently, the support for testing is limited.

We greatly appreciate your time and effort.

To keep the project consistent and maintainable, we have a few guidelines that we ask all contributors to follow. These guidelines help ensure that everyone can understand and work with the code easier.

See Contributing for more details.

• Special thanks to everyone who has contributed to this project...
  
  

  
  

  Made with contrib.rocks.

• Thanks to the welcoming community, the volunteers who helped along the journey, developers, contributors and contributors who put time and effort into everything including making all the libraries, tools, and the information we rely on

• We are incredibly grateful to many individuals and organizations who have played a role in the project. This includes the welcoming community, dedicated volunteers, talented developers and contributors, and the creators of the open-source tools we rely on.