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

Table of contents #

Flutter Quill

Installation #

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

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

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!

Please use the latest pre-release of FlutterQuill Extensions in order to work with the latest stable version of FlutterQuill

Usage #

See the example directory for a minimal example of how to use FlutterQuill. You typically just need to instantiate a controller:

QuillController _controller = QuillController.basic();

and then embed the toolbar and the editor, within your app. For example:

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 mehtod

Check out Sample Page for more advanced usage.

Migration #

We have recently add migration guide for migration from different versions

Input / Output #

This library uses Quill as an internal data format.

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:

var 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:

var myJSON = jsonDecode(r'{"insert":"hello\n"}');
_controller = QuillController(
          document: Document.fromJson(myJSON),
          selection: TextSelection.collapsed(offset: 0),
        );

Configurations #

The QuillToolbar class lets you customize which formatting options are available. Sample Page provides sample code for advanced usage and configuration.

For web development, use flutter config --enable-web for flutter or use ReactQuill for React.

It is required to provide EmbedBuilder, e.g. defaultEmbedBuildersWeb. Also it is required to provide webImagePickImpl, e.g. Sample Page.

For desktop platforms It is required to provide filePickImpl for toolbar image button, e.g. Sample Page.

Using Custom App Widget #

This project use some adaptive widgets like AdaptiveTextSelectionToolbar which require the following delegates:

Default Material Localizations delegate
Default Cupertino Localizations delegate
Defualt Widgets Localizations delegate

You don't need to include those since there are defined by default but if you are using Custom app or you are overriding the localizationsDelegates in the App widget then please make sure it's including those:

localizationsDelegates: const [
    DefaultCupertinoLocalizations.delegate,
    DefaultMaterialLocalizations.delegate,
    DefaultWidgetsLocalizations.delegate,
],

And you might need more depending on your use case, for example if you are using custom localizations for your app, using custom app widget like FluentApp from FluentUI which will also need

localizationsDelegates: const [
    // Required localizations delegates ...
    FluentLocalizations.delegate,
    AppLocalizations.delegate,
],

in addition to the required delegates by this library

Note: In the latest versions of FluentApp you no longer need to add the localizationsDelegates but this is just an example, for more info

Font Size #

Within the editor toolbar, a drop-down with font-sizing capabilities is available. This can be enabled or disabled with showFontSize.

When enabled, the default font-size values can be modified via optional fontSizeValues. fontSizeValues accepts a Map<String, String> consisting of a String title for the font size and a String value for the font size. Example:

fontSizeValues: const {'Small': '8', 'Medium': '24.5', 'Large': '46'}

Font size can be cleared with a value of 0, for example:

fontSizeValues: const {'Small': '8', 'Medium': '24.5', 'Large': '46', 'Clear': '0'}

Font Family #

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

Custom Buttons #

You may add custom buttons to the end of the toolbar, via the customButtons option, which is a List of QuillCustomButton.

To add an Icon, we should use a new QuillCustomButton class

    QuillCustomButton(
        iconData: Icons.ac_unit,
        onTap: () {
          debugPrint('snowflake');
        }
    ),

Each QuillCustomButton is used as part of the customButtons option as follows:

QuillToolbar(
  configurations: QuillToolbarConfigurations(
    customButtons: [
      QuillCustomButton(
        iconData: Icons.ac_unit,
        onTap: () {
          debugPrint('snowflake1');
        },
      ),
      QuillCustomButton(
        iconData: Icons.ac_unit,
        onTap: () {
          debugPrint('snowflake2');
        },
      ),
      QuillCustomButton(
        iconData: Icons.ac_unit,
        onTap: () {
          debugPrint('snowflake3');
        },
      ),
    ],
  ),
),

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` #

QuillToolbar(
  configurations: QuillToolbarConfigurations(
    embedButtons: FlutterQuillEmbeds.toolbarButtons(
      imageButtonOptions: QuillToolbarImageButtonOptions(
        onImagePickCallback: (file) async {
          return file.path;
        },
      ),
    ),
  ),
),

Expanded(
  child: QuillEditor.basic(
    configurations: QuillEditorConfigurations(
      readOnly: true,
      embedBuilders: FlutterQuillEmbeds.editorBuilders(
        imageEmbedConfigurations:
            const QuillEditorImageEmbedConfigurations(
          forceUseMobileOptionMenuForImageClick: true,
        ),
      ),
    ),
  ),
)

Custom Size Image for Mobile #

Define mobileWidth, mobileHeight, mobileMargin, mobileAlignment as follows:

{
      "insert": {
         "image": "https://user-images.githubusercontent.com/122956/72955931-ccc07900-3d52-11ea-89b1-d468a6e2aa2b.png"
      },
      "attributes":{
         "style":"mobileWidth: 50; mobileHeight: 50; mobileMargin: 10; mobileAlignment: topLeft"
      }
}

Custom Size Image for other platforms (excluding web) #

Define width, height, margin, alignment as follows:

{
      "insert": {
         "image": "https://user-images.githubusercontent.com/122956/72955931-ccc07900-3d52-11ea-89b1-d468a6e2aa2b.png"
      },
      "attributes":{
         "style":"width: 50; height: 50; margin: 10; alignment: topLeft"
      }
}

Custom Embed Blocks #

Sometimes you want to add some custom content inside your text, custom widgets inside of them. An example is adding notes to the text, or anything custom that you want to add in your text editor.

The only thing that you need is to add a CustomBlockEmbed and provider a builder for it to the embedBuilders parameter, to transform the data inside of the Custom Block into a widget!

Here is an example:

Starting with the CustomBlockEmbed, here we extend it and add the methods that are useful for the 'Note' widget, that will be the Document, used by the flutter_quill to render the rich text.

class NotesBlockEmbed extends CustomBlockEmbed {
  const NotesBlockEmbed(String value) : super(noteType, value);

  static const String noteType = 'notes';

  static NotesBlockEmbed fromDocument(Document document) =>
      NotesBlockEmbed(jsonEncode(document.toDelta().toJson()));

  Document get document => Document.fromJson(jsonDecode(data));
}

After that, we need to map this "notes" type into a widget. In that case, I used a ListTile with a text to show the plain text resume of the note, and the onTap function to edit the note. Don't forget to add this method to the QuillEditor after that!

class NotesEmbedBuilder extends EmbedBuilder {
  NotesEmbedBuilder({required this.addEditNote});

  Future<void> Function(BuildContext context, {Document? document}) addEditNote;

  @override
  String get key => 'notes';

  @override
  Widget build(
    BuildContext context,
    QuillController controller,
    Embed node,
    bool readOnly,
    bool inline,
    TextStyle textStyle,
  ) {
    final notes = NotesBlockEmbed(node.value.data).document;

    return Material(
      color: Colors.transparent,
      child: ListTile(
        title: Text(
          notes.toPlainText().replaceAll('\n', ' '),
          maxLines: 3,
          overflow: TextOverflow.ellipsis,
        ),
        leading: const Icon(Icons.notes),
        onTap: () => addEditNote(context, document: notes),
        shape: RoundedRectangleBorder(
          borderRadius: BorderRadius.circular(10),
          side: const BorderSide(color: Colors.grey),
        ),
      ),
    );
  }
}

And finally, we write the function to add/edit this note. The showDialog function shows the QuillEditor to edit the note, after the user ends the edition, we check if the document has something, and if it has, we add or edit the NotesBlockEmbed inside of a BlockEmbed.custom (this is a little detail that will not work if you don't pass the CustomBlockEmbed inside of a BlockEmbed.custom).

Future<void> _addEditNote(BuildContext context, {Document? document}) async {
  final isEditing = document != null;
  final quillEditorController = QuillController(
    document: document ?? Document(),
    selection: const TextSelection.collapsed(offset: 0),
  );

  await showDialog(
    context: context,
    builder: (context) => AlertDialog(
      titlePadding: const EdgeInsets.only(left: 16, top: 8),
      title: Row(
        mainAxisAlignment: MainAxisAlignment.spaceBetween,
        children: [
          Text('${isEditing ? 'Edit' : 'Add'} note'),
          IconButton(
            onPressed: () => Navigator.of(context).pop(),
            icon: const Icon(Icons.close),
          )
        ],
      ),
      content: QuillEditor.basic(
        controller: quillEditorController,
        readOnly: false,
      ),
    ),
  );

  if (quillEditorController.document.isEmpty()) return;

  final block = BlockEmbed.custom(
    NotesBlockEmbed.fromDocument(quillEditorController.document),
  );
  final controller = _controller!;
  final index = controller.selection.baseOffset;
  final length = controller.selection.extentOffset - index;

  if (isEditing) {
    final offset = getEmbedNode(controller, controller.selection.start).offset;
    controller.replaceText(
        offset, 1, block, TextSelection.collapsed(offset: offset));
  } else {
    controller.replaceText(index, length, block, null);
  }
}

And voila, we have a custom widget inside of the rich text editor!

For more info and a video example, see the PR of this feature

For more details, check out this YouTube video

If you want to use custom toolbar but still want the support of this libray You can use the QuillBaseToolbar which is the base for the QuillToolbar

If you are using the toolbar buttons like QuillToolbarHistoryButton, QuillToolbarToggleStyleButton in the somewhere like the the custom toolbar then you must provide them with QuillToolbarProvider inherited widget, you don't have to do this if you are using the QuillToolbar since it will be done for you

Example:

QuillProvider(
  configurations: QuillConfigurations(
    controller: _controller,
    sharedConfigurations: const QuillSharedConfigurations(),
  ),
  child: Column(
    children: [
      QuillToolbarProvider(
        toolbarConfigurations: const QuillToolbarConfigurations(),
        child: QuillBaseToolbar(
          configurations: QuillBaseToolbarConfigurations(
            toolbarSize: 15 * 2,
            multiRowsDisplay: false,
            childrenBuilder: (context) {
              final controller = context.requireQuillController;
              return [
                QuillToolbarHistoryButton(
                  controller: controller,
                  options: const QuillToolbarHistoryButtonOptions(
                      isUndo: true),
                ),
                QuillToolbarHistoryButton(
                  controller: controller,
                  options: const QuillToolbarHistoryButtonOptions(
                      isUndo: false),
                ),
                QuillToolbarToggleStyleButton(
                  attribute: Attribute.bold,
                  controller: controller,
                  options: const QuillToolbarToggleStyleButtonOptions(
                    iconData: Icons.format_bold,
                    iconSize: 20,
                  ),
                ),
                QuillToolbarToggleStyleButton(
                  attribute: Attribute.italic,
                  controller: controller,
                  options: const QuillToolbarToggleStyleButtonOptions(
                    iconData: Icons.format_italic,
                    iconSize: 20,
                  ),
                ),
                QuillToolbarToggleStyleButton(
                  attribute: Attribute.underline,
                  controller: controller,
                  options: const QuillToolbarToggleStyleButtonOptions(
                    iconData: Icons.format_underline,
                    iconSize: 20,
                  ),
                ),
                QuillToolbarClearFormatButton(
                  controller: controller,
                  options: const QuillToolbarClearFormatButtonOptions(
                    iconData: Icons.format_clear,
                    iconSize: 20,
                  ),
                ),
                VerticalDivider(
                  indent: 12,
                  endIndent: 12,
                  color: Colors.grey.shade400,
                ),
                QuillToolbarSelectHeaderStyleButtons(
                  controller: controller,
                  options:
                      const QuillToolbarSelectHeaderStyleButtonsOptions(
                    iconSize: 20,
                  ),
                ),
                QuillToolbarToggleStyleButton(
                  attribute: Attribute.ol,
                  controller: controller,
                  options: const QuillToolbarToggleStyleButtonOptions(
                    iconData: Icons.format_list_numbered,
                    iconSize: 20,
                  ),
                ),
                QuillToolbarToggleStyleButton(
                  attribute: Attribute.ul,
                  controller: controller,
                  options: const QuillToolbarToggleStyleButtonOptions(
                    iconData: Icons.format_list_bulleted,
                    iconSize: 20,
                  ),
                ),
                QuillToolbarToggleStyleButton(
                  attribute: Attribute.blockQuote,
                  controller: controller,
                  options: const QuillToolbarToggleStyleButtonOptions(
                    iconData: Icons.format_quote,
                    iconSize: 20,
                  ),
                ),
                VerticalDivider(
                  indent: 12,
                  endIndent: 12,
                  color: Colors.grey.shade400,
                ),
                QuillToolbarIndentButton(
                    controller: controller,
                    isIncrease: true,
                    options: const QuillToolbarIndentButtonOptions(
                      iconData: Icons.format_indent_increase,
                      iconSize: 20,
                    )),
                QuillToolbarIndentButton(
                  controller: controller,
                  isIncrease: false,
                  options: const QuillToolbarIndentButtonOptions(
                    iconData: Icons.format_indent_decrease,
                    iconSize: 20,
                  ),
                ),
              ];
            },
          ),
        ),
      ),
      Expanded(
        child: QuillEditor.basic(
          configurations: const QuillEditorConfigurations(
            readOnly: false,
            placeholder: 'Write your notes',
            padding: EdgeInsets.all(16),
          ),
        ),
      )
    ],
  ),
)

if you want more customized toolbar feel free to create your own and use the controller to interact with the editor. checkout the QuillToolbar and the buttons inside it to see an example of how that will works

Translation #

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

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

#

Currently, translations are available for these 31 locales:

Locale('en')
Locale('ar')
Locale('bn')
Locale('bs')
Locale('cs')
Locale('de')
Locale('da')
Locale('fr')
Locale('he')
Locale('zh', 'cn')
Locale('zh', 'hk')
Locale('ko')
Locale('ru')
Locale('es')
Locale('tk')
Locale('tr')
Locale('uk')
Locale('ur')
Locale('pt')
Locale('pl')
Locale('vi')
Locale('id')
Locale('it')
Locale('ms')
Locale('nl')
Locale('no')
Locale('fa')
Locale('hi')
Locale('sr')
Locale('sw')
Locale('ja')

Contributing to translations

The translation file is located at toolbar.i18n.dart. Feel free to contribute your own translations, just copy the English translations map and replace the values with your translations. Then open a pull request so everyone can benefit from your translations!

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 in order to publish it, or send an email. One option is to use vsc_quill_delta_to_html to convert your document to HTML. This package has full support for all Quill operations - including images, videos, formulas, tables, and mentions. Conversion can be performed in vanilla Dart (i.e., server-side or CLI) or in Flutter. It is a complete Dart part of the popular and mature quill-delta-to-html Typescript/Javascript package.

Testing #

To aid in testing applications using the editor an extension to the flutter WidgetTester is provided which includes methods to simplify interacting with the editor in test cases.

Import the test utilities in your test file:

import 'package:flutter_quill/flutter_quill_test.dart';

and then enter text using quillEnterText:

await tester.quillEnterText(find.byType(QuillEditor), 'test\n');

License #

MIT

Contributors #

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

Made with contrib.rocks.

中文文档

flutter_quill 8.2.0
flutter_quill: ^8.2.0 copied to clipboard

Metadata

Flutter Quill #

A rich text editor for Flutter

Table of contents #

Installation #

Usage #

Migration #

Input / Output #

Configurations #

Using Custom App Widget #

Font Size #

Font Family #

Custom Buttons #

Embed Blocks #

Using the embed blocks from `flutter_quill_extensions` #

Custom Size Image for Mobile #

Custom Size Image for other platforms (excluding web) #

Custom Embed Blocks #

Translation #

#

Contributing to translations

Conversion to HTML #

Testing #

License #

Contributors #

← Metadata

Publisher

Metadata

Topics

License

Dependencies

More

flutter_quill 8.2.0 flutter_quill: ^8.2.0 copied to clipboard

Metadata

Flutter Quill #

A rich text editor for Flutter

Table of contents #

Installation #

Usage #

Migration #

Input / Output #

Configurations #

Using Custom App Widget #

Font Size #

Font Family #

Custom Buttons #

Embed Blocks #

Using the embed blocks from flutter_quill_extensions #

Custom Size Image for Mobile #

Custom Size Image for other platforms (excluding web) #

Custom Embed Blocks #

Custom Toolbar #

Translation #

#

Contributing to translations

Conversion to HTML #

Testing #

License #

Contributors #

← Metadata

Publisher

Metadata

Topics

License

Dependencies

More

flutter_quill 8.2.0
flutter_quill: ^8.2.0 copied to clipboard

Using the embed blocks from `flutter_quill_extensions` #