AI prompts
base on Rich text editor for Flutter # Flutter Quill
<p align="center" style="background-color:#282C34">
<img src="https://user-images.githubusercontent.com/10923085/119221946-2de89000-baf2-11eb-8285-68168a78c658.png" width="600px" alt="Flutter Quill">
</p>
<h1 align="center">A rich text editor for Flutter</h1>
[![MIT License][license-badge]][license-link]
[![PRs Welcome][prs-badge]][prs-link]
[![Watch on GitHub][github-watch-badge]][github-watch-link]
[![Star on GitHub][github-star-badge]][github-star-link]
[![Watch on GitHub][github-forks-badge]][github-forks-link]
[license-badge]: https://img.shields.io/github/license/singerdmx/flutter-quill.svg?style=for-the-badge
[license-link]: ./LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
[prs-link]: https://github.com/singerdmx/flutter-quill/issues
[github-watch-badge]: https://img.shields.io/github/watchers/singerdmx/flutter-quill.svg?style=for-the-badge&logo=github&logoColor=ffffff
[github-watch-link]: https://github.com/singerdmx/flutter-quill/watchers
[github-star-badge]: https://img.shields.io/github/stars/singerdmx/flutter-quill.svg?style=for-the-badge&logo=github&logoColor=ffffff
[github-star-link]: https://github.com/singerdmx/flutter-quill/stargazers
[github-forks-badge]: https://img.shields.io/github/forks/singerdmx/flutter-quill.svg?style=for-the-badge&logo=github&logoColor=ffffff
[github-forks-link]: https://github.com/singerdmx/flutter-quill/network/members
---
**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](./doc/code_introduction.md)
to take a detailed walkthrough of the code base.
You can join our [Slack Group] for discussion.
> [!NOTE]
> If you are viewing this page from [pub.dev](https://pub.dev/) page, then you
> might experience some issues with opening some links or
> unsupported [GitHub alerts](https://github.com/orgs/community/discussions/16925)
## π Table of contents
- [πΈ Screenshots](#-screenshots)
- [π¦ Installation](#-installation)
- [π Platform Specific Configurations](#-platform-specific-configurations)
- [π Usage](#-usage)
- [π₯ Breaking Changes](#-breaking-changes)
- [π€ Input / Output](#-input--output)
- [βοΈ Configurations](#οΈ-configurations)
- [π¦ Embed Blocks](#-embed-blocks)
- [π Conversion to HTML](#-conversion-to-html)
- [π Spelling checker](#-spelling-checker)
- [π Rich Text Paste](#-rich-text-paste)
- [βοΈ Shortcut events](#-shortcut-events)
- [π Translation](#-translation)
- [π§ͺ Testing](#-testing)
- [π€ Contributing](#-contributing)
- [π Acknowledgments](#-acknowledgments)
## πΈ Screenshots
<details>
<summary>Tap to show/hide screenshots</summary>
<br>
<img src="https://github.com/singerdmx/flutter-quill/blob/master/example/assets/images/screenshot_1.png?raw=true" width="250" alt="Screenshot 1">
<img src="https://github.com/singerdmx/flutter-quill/blob/master/example/assets/images/screenshot_2.png?raw=true" width="250" alt="Screenshot 2">
<img src="https://github.com/singerdmx/flutter-quill/blob/master/example/assets/images/screenshot_3.png?raw=true" width="250" alt="Screenshot 3">
<img src="https://github.com/singerdmx/flutter-quill/blob/master/example/assets/images/screenshot_4.png?raw=true" width="250" alt="Screenshot 4">
</details>
## π¦ Installation
```yaml
dependencies:
flutter_quill: ^<latest-version-here>
```
<p align="center">OR</p>
```yaml
dependencies:
flutter_quill:
git:
url: https://github.com/singerdmx/flutter-quill.git
ref: v<latest-version-here>
```
> [!TIP]
> 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 the developers. Thank you for
> being part of the open-source community!
>
## π Platform Specific Configurations
The `flutter_quill` package uses the following plugins:
1. [`url_launcher`](https://pub.dev/packages/url_launcher): to open links.
2. [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge): to access platform-specific APIs for the
editor.
3. [`flutter_keyboard_visibility_temp_fork`](https://pub.dev/packages/flutter_keyboard_visibility_temp_fork) to listen for keyboard
visibility changes.
### Android Configuration for `quill_native_bridge`
To support copying images to the clipboard to be accessed by other apps, you need to configure your Android project.
If not set up, a warning will appear in the log during debug mode only.
> [!TIP]
> This is only required on **Android** for this optional feature.
> You should be able to copy images and paste them inside the editor without any additional configuration.
**1. Update `AndroidManifest.xml`**
Open `your_project/android/app/src/main/AndroidManifest.xml` and add the following inside the `<application>` tag:
```xml
<manifest>
<application>
...
<provider
android:name="androidx.core.content.FileProvider"
android:authorities="${applicationId}.fileprovider"
android:exported="false"
android:grantUriPermissions="true" >
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_paths" />
</provider>
...
</application>
</manifest>
```
**2. Create `file_paths.xml`**
Create the file `your_project/android/app/src/main/res/xml/file_paths.xml` with the following content:
```xml
<paths>
<cache-path name="cache" path="." />
</paths>
```
> [!NOTE]
> Starting with Flutter Quill `10.8.4`, [super_clipboard](https://pub.dev/packages/super_clipboard) is no longer required in `flutter_quill` or `flutter_quill_extensions`.
> The new default is an internal plugin, [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge).
> If you want to continue using `super_clipboard`, you can use the [quill_super_clipboard](https://pub.dev/packages/quill_super_clipboard) package (support may be discontinued).
## π Usage
Instantiate a controller:
```dart
QuillController _controller = QuillController.basic();
```
Use the `QuillEditor`, and `QuillSimpleToolbar` widgets,
and attach the `QuillController` to them:
```dart
QuillSimpleToolbar(
controller: _controller,
configurations: const QuillSimpleToolbarConfigurations(),
),
Expanded(
child: QuillEditor.basic(
controller: _controller,
configurations: const QuillEditorConfigurations(),
),
)
```
Dispose of the `QuillController` in the `dispose` method:
```dart
@override
void dispose() {
_controller.dispose();
super.dispose();
}
```
Check out [Sample Page] for more advanced usage.
## π₯ Breaking Changes
- APIs marked with [`@experimental`](https://api.flutter.dev/flutter/meta/experimental-constant.html)
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`](https://api.flutter.dev/flutter/meta/internal-constant.html)
and [`@visibleForTesting`](https://api.flutter.dev/flutter/meta/visibleForTesting-constant.html) 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.
## π€ Input / Output
This library uses [Quill Delta](https://quilljs.com/docs/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.
> [!NOTE]
> Donβt be confused by its name DeltaβDeltas represents both documents and changes to documents.
> If you think of Deltas as the instructions for going from one document to another,
> the way Deltas represents 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.
To save a document as a JSON:
```dart
final json = jsonEncode(_controller.document.toDelta().toJson());
```
To open the editor with an existing JSON representation that you've previously stored:
```dart
final json = jsonDecode(r'{"insert":"hello\n"}');
_controller.document = Document.fromJson(json);
```
### π Links
- [Quill Delta](https://quilljs.com/docs/delta/)
- [Quill Delta Formats](https://quilljs.com/docs/formats)
- [Why Quill](https://quilljs.com/guides/why-quill/)
- [Quill JS Configurations](https://quilljs.com/docs/configuration/)
- [Quill JS Interactive Playground](https://quilljs.com/playground/)
- [Quill JS GitHub repo](https://github.com/quilljs/quill)
## βοΈ Configurations
The `QuillSimpleToolbar` and `QuillEditor` widgets are both customizable.
[Sample Page] provides sample code for advanced usage and configuration.
### π Links
- [Using Custom App Widget](./doc/configurations/using_custom_app_widget.md)
- [Localizations Setup](./doc/configurations/localizations_setup.md)
- [Font Size](./doc/configurations/font_size.md)
- [Font Family](#font-family)
- [Custom Toolbar buttons](./doc/configurations/custom_buttons.md)
- [Search](./doc/configurations/search.md)
### π Font Family
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),
[this article](https://stackoverflow.com/questions/55075834/fontfamily-property-not-working-properly-in-flutter)
and [this](https://www.flutterbeads.com/change-font-family-flutter/).
## π¦ Embed Blocks
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`](https://pub.dev/packages/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]
### π Links
- [Custom Embed Blocks](./doc/custom_embed_blocks.md)
- [Custom Toolbar](./doc/custom_toolbar.md)
## π Conversion to HTML
> [!CAUTION]
> **Converting HTML or Markdown to Delta is highly experimental and shouldn't be used for production applications**,
> while the current implementation we have internally is far from perfect, it could improved however **it will likely
not
work as expected**, due to differences between **HTML** and **Delta**, see
> this [Quill JS Comment #311458570](https://github.com/slab/quill/issues/1551#issuecomment-311458570) for more
> info.<br>
> We only use it **internally** as it is more suitable for our specific use case, copying content from external websites
> and pasting it into the editor
> previously breaks the styles, while the current implementation is not designed for converting a **full Document** from
> other formats to **Delta**, it provides a better user experience and doesn't have many downsides.
>
> The support for converting HTML to **Quill Delta** is quite experimental and used internally when
> pasting HTML content from the clipboard to the Quill Document.
>
> Converting **Delta** from/to **HTML** is not a standard feature in [Quill JS](https://github.com/slab/quill)
> or [FlutterQuill].
> [!IMPORTANT]
> Converting **HTML** to **Delta** usually won't work as expected, we highly recommend storing the **Document** as *
*Delta JSON**
> in the database instead of other formats (e.g., HTML, Markdown, PDF, Microsoft Word, Google Docs, Apple Pages, XML,
> CSV,
> etc...)
>
> Converting between **HTML** and **Delta** JSON is generally not recommended due to their structural and functional
> differences.
>
> Sometimes you might want to convert between **HTML** and **Delta** for specific use cases:
>
> 1. **Migration**: If you're using an existing system that stores the data in HTML and want to convert the document
data to **Delta**.
> 2. **Sharing**: For example, if you want to share the Document **Delta** somewhere or send it as an email.
> 3. **Save as**: If your app has a feature that allows converting Documents to other formats.
> 4. **Rich text pasting**: If you copy some content from websites or apps, and want to paste it into the app.
> 5. **SEO**: In case you want to use HTML for SEO support.
The following packages can be used:
1. [`vsc_quill_delta_to_html`](https://pub.dev/packages/vsc_quill_delta_to_html): To convert **Delta**
to **HTML**.
2. [`flutter_quill_delta_from_html`](https://pub.dev/packages/flutter_quill_delta_from_html): To convert **HTML** to **Delta**.
3. [`flutter_quill_to_pdf`](https://pub.dev/packages/flutter_quill_to_pdf): To convert **Delta** To **PDF**.
4. [`markdown_quill`](https://pub.dev/packages/markdown_quill): To convert **Markdown** To **Delta** and vice versa.
## π Spelling checker
This feature is currently not implemented and is being planned. Refer to [#2246](https://github.com/singerdmx/flutter-quill/issues/2246)
for discussion.
## π Rich Text Paste
This feature allows the user to paste the content copied from other apps into the editor as rich text.
The plugin [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge) provides access to the system Clipboard.
> [!IMPORTANT]
> Currently this feature is not supported on the web.
> See [issue #1998](https://github.com/singerdmx/flutter-quill/issues/1998) and [issue #2220](https://github.com/singerdmx/flutter-quill/issues/2220)
for more details
## βοΈ Shortcut events
We can customize some Shorcut events, using the parameters `characterShortcutEvents` or `spaceShortcutEvents` from `QuillEditorConfigurations` to add more functionality to our editor.
> [!NOTE]
>
> You can get all standard shortcuts using `standardCharactersShortcutEvents` or `standardSpaceShorcutEvents`
To see an example of this, you can check [customizing_shortcuts](./doc/customizing_shortcuts.md)
## π 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](./doc/translation.md) for more info
## π§ͺ Testing
Take a look at [flutter_quill_test](https://pub.dev/packages/flutter_quill_test) for testing.
Notice that currently, the support for testing is limited.
## π€ Contributing
> [!IMPORTANT]
> At this time, we prioritize bug fixes and code quality improvements over new features.
> Please refrain from submitting large changes to add new features, as they might
> not be merged, and exceptions may made.
> We encourage you to create an issue or reach out beforehand,
> explaining your proposed changes and their rationale for a higher chance of acceptance. Thank you!
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](./CONTRIBUTING.md) for more details.
## π Acknowledgments
- Special thanks to everyone who has contributed to this project...
<br><br>
<a href="https://github.com/singerdmx/flutter-quill/graphs/contributors">
<img src="https://contrib.rocks/image?repo=singerdmx/flutter-quill" alt="Contributors"/>
</a>
<br>
Made with [contrib.rocks](https://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.
[Quill]: https://quilljs.com/docs/formats
[Flutter]: https://github.com/flutter/flutter
[FlutterQuill]: https://pub.dev/packages/flutter_quill
[FlutterQuill Extensions]: https://pub.dev/packages/flutter_quill_extensions
[ReactQuill]: https://github.com/zenoamaro/react-quill
[Youtube Playlist]: https://youtube.com/playlist?list=PLbhaS_83B97vONkOAWGJrSXWX58et9zZ2
[Slack Group]: https://join.slack.com/t/bulletjournal1024/shared_invite/zt-fys7t9hi-ITVU5PGDen1rNRyCjdcQ2g
[Sample Page]: https://github.com/singerdmx/flutter-quill/blob/master/example/lib/screens/quill/quill_screen.dart
", Assign "at most 3 tags" to the expected json: {"id":"9489","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"