FlutterQuill is a rich text editor and a [Quill] component for [Flutter].
This library is a WYSIWYG editor built for the modern mobile platform, with web compatibility under development. 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.
@ -63,9 +81,9 @@ 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 serialisation support, so that you can save and open documents. To save a document as JSON, do something like the following:
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:
```
```dart
var json = jsonEncode(_controller.document.toDelta().toJson());
```
@ -73,11 +91,12 @@ 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:
```
```dart
var myJSON = jsonDecode(incomingJSONText);
_controller = QuillController(
document: Document.fromJson(myJSON),
selection: TextSelection.collapsed(offset: 0));
selection: TextSelection.collapsed(offset: 0),
);
```
## Web
@ -93,30 +112,36 @@ It is required to provide `filePickImpl` for toolbar image button, e.g. [Sample
## Configuration
The `QuillToolbar` class lets you customise which formatting options are available.
The `QuillToolbar` class lets you customize which formatting options are available.
[Sample Page] provides sample code for advanced usage and configuration.
### Font Size
Within the editor toolbar, a drop-down with font-sizing capabilities is available. This can be enabled or disabled with `showFontSize`.
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:
To use your own fonts, update your [assets folder](https://github.com/singerdmx/flutter-quill/tree/master/example/assets/fonts) and pass in `fontFamilyValues`. More details at [this change](https://github.com/singerdmx/flutter-quill/commit/71d06f6b7be1b7b6dba2ea48e09fed0d7ff8bbaa), [this article](https://stackoverflow.com/questions/55075834/fontfamily-property-not-working-properly-in-flutter) and [this](https://www.flutterbeads.com/change-font-family-flutter/).
### 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
```
```dart
QuillCustomButton(
icon:Icons.ac_unit,
onTap: () {
@ -126,7 +151,8 @@ To add an Icon, we should use a new QuillCustomButton class
```
Each `QuillCustomButton` is used as part of the `customButtons` option as follows:
```
```dart
QuillToolbar.basic(
(...),
customButtons: [
@ -153,16 +179,15 @@ QuillToolbar.basic(
]
```
## 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`](https://pub.dev/packages/flutter_quill_extensions).
Provide a list of embed
Provide a list of embed
### Using the embed blocks from `flutter_quill_extensions`
Currently, translations are available for these 23 locales:
Currently, translations are available for these 24 locales:
* `Locale('en')`
* `Locale('ar')`
@ -350,24 +373,11 @@ Currently, translations are available for these 23 locales:
* `Locale('fa')`
* `Locale('hi')`
* `Locale('sr')`
* `Locale('jp')`
#### Contributing to translations
The translation file is located at [toolbar.i18n.dart](lib/src/translations/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!
The translation file is located at [toolbar.i18n.dart](lib/src/translations/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!
## Sponsors
@ -376,10 +386,6 @@ The translation file is located at [toolbar.i18n.dart](lib/src/translations/tool
进行 Web 开发需要提供 `EmbedBuilder`, 参考：[defaultEmbedBuilderWeb](https://github.com/singerdmx/flutter-quill/blob/master/example/lib/universal_ui/universal_ui.dart#L29).
进行 Web 开发还需要提供 `webImagePickImpl`, 参考： [示例页面](https://github.com/singerdmx/flutter-quill/blob/master/example/lib/pages/home_page.dart#L225).
Cierra_Runis
2 years ago
committed by
GitHub