Flutter Quill

A rich text editor for Flutter

FlutterQuill 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.

Pub: FlutterQuill
If you are viewing this page from pub.dev page, then you might have some issues with opening some links, please open it in GitHub repo instead.

Table of contents

Flutter Quill

Screenshots

Tap to show/hide screenshots

Installation

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

OR

dependencies:
  flutter_quill:
    git: https://github.com/singerdmx/flutter-quill.git

Note: At this time, we are making too many changes to the library, and you might see a new version almost every day

Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement of the library. Your input and insights are valuable in shaping a stable and reliable version for all our users. Thank you for being part of the open-source community!

If the latest version of FlutterQuill Extensions is pre-release, then please use it to work with the latest stable version of FlutterQuill

Compatible versions:

flutter_quill	flutter_quill_extensions	flutter_quill_test
8.6.x	0.7.x	0.0.5
8.5.x	0.6.x	0.0.5

These versions are tested and well-supported, you shouldn't get a build failure

Usage

First, you need to instantiate a controller

QuillController _controller = QuillController.basic();

And then use the QuillEditor, QuillToolbar widgets, connect the QuillController to them using QuillProvider inherited widget

QuillProvider(
  configurations: QuillConfigurations(
    controller: _controller,
    sharedConfigurations: const QuillSharedConfigurations(
      locale: Locale('de'),
    ),
  ),
  child: Column(
    children: [
      const QuillToolbar(),
      Expanded(
        child: QuillEditor.basic(
          configurations: const QuillEditorConfigurations(
            readOnly: false,
          ),
        ),
      )
    ],
  ),
)

And depending on your use case, you might want to dispose the _controller in dispose method

in most cases, it's better to.

Check out Sample Page for more advanced usage.

Migration

Starting from version 8.0.0 We have added Migration Guide for migration from different versions

Input / Output

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.

Don’t be confused by its name Delta—Deltas represents both documents and changes to documents. If you think of Deltas as the instructions from going from one document to another, the way Deltas represent a document is by expressing the instructions starting from an empty document.

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

FlutterQuill provides some JSON serialization support, so that you can save and open documents. To save a document as JSON, do something like the following:

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

You can then write this to storage.

To open a FlutterQuill editor with an existing JSON representation that you've previously stored, you can do something like this:

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

_controller.document = Document.fromJson(json);

Links

Configurations

The QuillToolbar and QuillEditor widgets lets you customize a lot of things Sample Page provides sample code for advanced usage and configuration.

Links

Font Family

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

Embed Blocks

As of version 6.0, embed blocks are not provided by default as part of this package. Instead, this package provides an interface to all the user to provide there own implementations for embed blocks. Implementations for image, video and formula embed blocks is proved in a separate package flutter_quill_extensions.

Provide a list of embed

Using the embed blocks from `flutter_quill_extensions`

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

Links

Conversion to HTML

Having your document stored in Quill Delta format is sometimes not enough. Often you'll need to convert it to other formats such as HTML to publish it, or send an email.

You have two options:

Translation

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

Testing

Please use flutter_quill_test for testing

Contributors

Special thanks for everyone that has contributed to this project...

Made with contrib.rocks.

We welcome contributions!

Please follow these guidelines when contributing to the project. See CONTRIBUTING.md for more details.

We must mention that the CONTRIBUTING.md have a development notes, so if you're planning on contributing to the repo, please consider reading it.

You can check the Todo list if you want to

License

sobotkami/flutter-quill

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages