> Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement of the library.
> Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement
> Your input and insights are valuable in shaping a stable and reliable version for all the developers. Thank you for being part of the open-source community!
> of the library.
> Your input and insights are valuable in shaping a stable and reliable version for all the developers. Thank you for
> being part of the open-source community!
>
>
## Platform Specific Configurations
## Platform Specific Configurations
Before using the package, we must inform you the package use the following plugins:
Before using the package, we must inform you the package uses the following plugins:
```
```
url_launcher
url_launcher
flutter_keyboard_visibility
flutter_keyboard_visibility
device_info_plus
device_info_plus
```
```
All of them doesn't require any platform specific setup.
All of them don't require any platform-specific setup.
> Starting from Flutter Quill `9.4.x`, [super_clipboard](https://pub.dev/packages/super_clipboard) has been moved to [FlutterQuill Extensions], to use rich text features, support pasting images, gif files, take a look at `flutter_quill_extensions` Readme.
> Starting from Flutter Quill `9.4.x`, [super_clipboard](https://pub.dev/packages/super_clipboard) has been moved
> to [FlutterQuill Extensions], to use rich text features, support pasting images, gif files, take a look
> at `flutter_quill_extensions` Readme.
## Usage
## Usage
@ -143,6 +158,7 @@ in most cases, it's better to.
Check out [Sample Page] for more advanced usage.
Check out [Sample Page] for more advanced usage.
## Migration
## Migration
Starting from version `8.0.0`
Starting from version `8.0.0`
We have added [Migration Guide](/doc/migration.md) for migration from different versions
We have added [Migration Guide](/doc/migration.md) for migration from different versions
@ -170,7 +186,7 @@ final json = jsonEncode(_controller.document.toDelta().toJson());
You can then write this to storage.
You can then write this to storage.
To open a FlutterQuill editor with an existing JSON representation that you've previously stored,
To open a FlutterQuill editor with an existing JSON representation that you've previously stored,
you can do something like this:
you can do something like this:
```dart
```dart
@ -194,6 +210,7 @@ The `QuillToolbar` and `QuillEditor` widgets let you customize a lot of things
[Sample Page] provides sample code for advanced usage and configuration.
[Sample Page] provides sample code for advanced usage and configuration.
@ -202,19 +219,27 @@ The `QuillToolbar` and `QuillEditor` widgets let you customize a lot of things
### Font Family
### Font Family
To use your own fonts, update your [assets folder](./example/assets/fonts) and pass in `fontFamilyValues`.
To use your own fonts, update your [Assets](./example/assets/fonts) folder and pass in `fontFamilyValues`.
More details on [this commit](https://github.com/singerdmx/flutter-quill/commit/71d06f6b7be1b7b6dba2ea48e09fed0d7ff8bbaa),
More details
[this article](https://stackoverflow.com/questions/55075834/fontfamily-property-not-working-properly-in-flutter) and [this](https://www.flutterbeads.com/change-font-family-flutter/).
on [this commit](https://github.com/singerdmx/flutter-quill/commit/71d06f6b7be1b7b6dba2ea48e09fed0d7ff8bbaa),
and [this](https://www.flutterbeads.com/change-font-family-flutter/).
## Embed Blocks
## 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 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`](https://pub.dev/packages/flutter_quill_extensions).
As of version 6.0, embed blocks are not provided by default as part of this package.
Instead, this package provides an interface for all the users to provide their own implementations for embed blocks.
### Using the embed blocks from `flutter_quill_extensions`
### Using the embed blocks from `flutter_quill_extensions`
To see how to use the extension package, please take a look at the [README](./flutter_quill_extensions/README.md) of [FlutterQuill Extensions]
To see how to use the extension package, please take a look at the [README](./flutter_quill_extensions/README.md)
of [FlutterQuill Extensions]
### Links
### Links
@ -226,25 +251,30 @@ To see how to use the extension package, please take a look at the [README](./fl
Having your document stored in Quill Delta format is sometimes not enough. Often you'll need to convert
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.
it to other formats such as HTML to publish it, or send an email.
**Note**: This package supports converting from HTML back to Quill delta but it's experimental and used internally when pasting HTML content from the clipboard to the Quill Editor
**Note**: This package supports converting from HTML back to Quill delta but it's experimental and used internally when
pasting HTML content from the clipboard to the Quill Editor
You have two options:
You have two options:
1. Using [quill_html_converter](./quill_html_converter/) to convert to HTML, the package can convert the Quill delta to HTML well
1. Using [quill_html_converter](./quill_html_converter/) to convert to HTML, the package can convert the Quill delta to
(it uses [vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html)), it is just a handy extension to do it more quickly
HTML well
1. Another option is to use
(it uses [vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html)), it is just a handy extension
[vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html) to convert your document
to do it more quickly
to HTML.
2. Another option is to use
[vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html) to convert your document
to HTML.
This package has full support for all Quill operations—including images, videos, formulas,
This package has full support for all Quill operations—including images, videos, formulas,
tables, and mentions.
tables, and mentions.
Conversion can be performed in vanilla Dart (i.e., server-side or CLI) or in Flutter.
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](https://www.npmjs.com/package/quill-delta-to-html)
Ellet
10 months ago