{"id":13550998,"url":"https://github.com/singerdmx/flutter-quill","last_synced_at":"2025-05-13T00:11:12.631Z","repository":{"id":36951629,"uuid":"321294152","full_name":"singerdmx/flutter-quill","owner":"singerdmx","description":"Rich text editor for Flutter","archived":false,"fork":false,"pushed_at":"2025-04-18T15:43:54.000Z","size":15317,"stargazers_count":2700,"open_issues_count":232,"forks_count":880,"subscribers_count":27,"default_branch":"master","last_synced_at":"2025-04-23T18:54:19.526Z","etag":null,"topics":["dartlang","editor","flutter","flutter-apps","flutter-examples","flutter-package","flutter-widget","quill","quill-delta","quilljs","reactquill","rich-text","rich-text-editor","wysiwyg","wysiwyg-editor"],"latest_commit_sha":null,"homepage":"https://pub.dev/packages/flutter_quill","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/singerdmx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-14T09:17:10.000Z","updated_at":"2025-04-22T09:40:30.000Z","dependencies_parsed_at":"2024-01-03T00:17:37.440Z","dependency_job_id":"4f3d5fbf-cec2-4d1b-92b9-2442c7bc2ffa","html_url":"https://github.com/singerdmx/flutter-quill","commit_stats":{"total_commits":2272,"total_committers":221,"mean_commits":10.28054298642534,"dds":0.6157570422535211,"last_synced_commit":"008d262b70e2fb89f46019073f58068c116b6b76"},"previous_names":[],"tags_count":231,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singerdmx%2Fflutter-quill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singerdmx%2Fflutter-quill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singerdmx%2Fflutter-quill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singerdmx%2Fflutter-quill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/singerdmx","download_url":"https://codeload.github.com/singerdmx/flutter-quill/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253843216,"owners_count":21972874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dartlang","editor","flutter","flutter-apps","flutter-examples","flutter-package","flutter-widget","quill","quill-delta","quilljs","reactquill","rich-text","rich-text-editor","wysiwyg","wysiwyg-editor"],"created_at":"2024-08-01T12:01:40.939Z","updated_at":"2025-05-13T00:11:12.608Z","avatar_url":"https://github.com/singerdmx.png","language":"Dart","funding_links":[],"categories":["Dart"],"sub_categories":[],"readme":"# Flutter Quill\n\n\u003cp align=\"center\" style=\"background-color:#282C34\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/10923085/119221946-2de89000-baf2-11eb-8285-68168a78c658.png\" width=\"600px\" alt=\"Flutter Quill\"\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eA rich text editor for Flutter\u003c/h1\u003e\n\n[![MIT License][license-badge]][license-link]\n[![PRs Welcome][prs-badge]][prs-link]\n[![Watch on GitHub][github-watch-badge]][github-watch-link]\n[![Star on GitHub][github-star-badge]][github-star-link]\n[![Watch on GitHub][github-forks-badge]][github-forks-link]\n\n[license-badge]: https://img.shields.io/github/license/singerdmx/flutter-quill.svg?style=for-the-badge\n\n[license-link]: ./LICENSE\n\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge\n\n[prs-link]: https://github.com/singerdmx/flutter-quill/issues\n\n[github-watch-badge]: https://img.shields.io/github/watchers/singerdmx/flutter-quill.svg?style=for-the-badge\u0026logo=github\u0026logoColor=ffffff\n\n[github-watch-link]: https://github.com/singerdmx/flutter-quill/watchers\n\n[github-star-badge]: https://img.shields.io/github/stars/singerdmx/flutter-quill.svg?style=for-the-badge\u0026logo=github\u0026logoColor=ffffff\n\n[github-star-link]: https://github.com/singerdmx/flutter-quill/stargazers\n\n[github-forks-badge]: https://img.shields.io/github/forks/singerdmx/flutter-quill.svg?style=for-the-badge\u0026logo=github\u0026logoColor=ffffff\n\n[github-forks-link]: https://github.com/singerdmx/flutter-quill/network/members\n\n---\n\n**Flutter Quill** is a rich text editor and a [Quill] component for [Flutter].\n\nThis library is a WYSIWYG (What You See Is What You Get) editor built\nfor the modern Android, iOS, web and desktop platforms.\n\nCheck out our [Youtube Playlist] or [Code Introduction](./doc/code_introduction.md)\nto take a detailed walkthrough of the code base.\nYou can join our [Slack Group] for discussion.\n\n\u003cp\u003e\n  \u003cimg src=\"https://github.com/singerdmx/flutter-quill/blob/master/example/assets/images/screenshot_1.png?raw=true\"\n    alt=\"A screenshot of the iOS example app\" height=\"400\"/\u003e\n  \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003cimg src=\"https://github.com/singerdmx/flutter-quill/blob/master/example/assets/images/screenshot_4.png?raw=true\"\n   alt=\"A screenshot of the web example app\" height=\"420\" /\u003e\n\u003c/p\u003e\n\n## 📚 Table of contents\n\n- [📦 Installation](#-installation)\n- [🛠 Platform Setup](#-platform-setup)\n- [🚀 Usage](#-usage)\n- [🔤 Input / Output](#-input--output)\n- [⚙️ Configurations](#️-configurations)\n- [📦 Embed Blocks](#-embed-blocks)\n- [🔄 Delta Conversion](#-delta-conversion)\n- [📝 Rich Text Paste](#-rich-text-paste)\n- [🌐 Translation](#-translation)\n- [🧪 Testing](#-testing)\n- [🤝 Contributing](#-contributing)\n- [📜 Acknowledgments](#-acknowledgments)\n\n## 📦 Installation\n\n```shell\nflutter pub add flutter_quill\n```\n\n\u003cp align=\"center\"\u003eOR\u003c/p\u003e\n\n```yaml\ndependencies:\n  flutter_quill:\n    git:\n      url: https://github.com/singerdmx/flutter-quill.git\n      ref: v\u003clatest-version-here\u003e\n```\n\n\u003e [!TIP]\n\u003e If you're using version `10.0.0`, see [the migration guide to migrate to `11.0.0`](https://github.com/singerdmx/flutter-quill/blob/master/doc/migration/10_to_11.md).\n\n## 🛠 Platform Setup\n\nThe `flutter_quill` package uses the following plugins:\n\n1. [`url_launcher`](https://pub.dev/packages/url_launcher): to open links.\n2. [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge): to access platform-specific APIs for the\n   editor.\n3. [`flutter_keyboard_visibility_temp_fork`](https://pub.dev/packages/flutter_keyboard_visibility_temp_fork) to listen for keyboard\n   visibility changes.\n\n### Android Configuration for `quill_native_bridge`\n\nTo support copying images to the clipboard to be accessed by other apps, you need to configure your Android project.\nIf not set up, a warning will appear in the log during debug mode only.\n\n\u003e [!TIP]\n\u003e This is only required on **Android** for this optional feature.\n\u003e You should be able to copy images and paste them inside the editor without any additional configuration.\n\n**1. Update `AndroidManifest.xml`**\n\nOpen `android/app/src/main/AndroidManifest.xml` and add the following inside the `\u003capplication\u003e` tag:\n\n```xml\n\u003cmanifest\u003e\n    \u003capplication\u003e\n        ...\n        \u003cprovider\n            android:name=\"androidx.core.content.FileProvider\"\n            android:authorities=\"${applicationId}.fileprovider\"\n            android:exported=\"false\"\n            android:grantUriPermissions=\"true\" \u003e\n            \u003cmeta-data\n                android:name=\"android.support.FILE_PROVIDER_PATHS\"\n                android:resource=\"@xml/file_paths\" /\u003e\n        \u003c/provider\u003e\n        ...\n    \u003c/application\u003e\n\u003c/manifest\u003e\n```\n\n**2. Create `file_paths.xml`**\n\nCreate the file `android/app/src/main/res/xml/file_paths.xml` with the following content:\n\n```xml\n\u003cpaths\u003e\n    \u003ccache-path name=\"cache\" path=\".\" /\u003e\n\u003c/paths\u003e\n```\n\n\u003e [!NOTE]\n\u003e 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`.\n\u003e The new default is an internal plugin [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge).\n\u003e 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).\n\n## 🚀 Usage\n\nAdd the localization delegate to your app widget:\n\n```dart\nimport 'package:flutter_quill/flutter_quill.dart';\nimport 'package:flutter_localizations/flutter_localizations.dart';\n\nMaterialApp(\n  localizationsDelegates: const [\n    GlobalMaterialLocalizations.delegate,\n    GlobalCupertinoLocalizations.delegate,\n    GlobalWidgetsLocalizations.delegate,\n    FlutterQuillLocalizations.delegate,\n  ]，\n);\n```\n\nInstantiate a controller:\n\n```dart\nQuillController _controller = QuillController.basic();\n```\n\nUse the `QuillEditor` and `QuillSimpleToolbar` widgets,\nand attach the `QuillController` to them:\n\n```dart\nQuillSimpleToolbar(\n  controller: _controller,\n  config: const QuillSimpleToolbarConfig(),\n),\nExpanded(\n  child: QuillEditor.basic(\n    controller: _controller,\n    config: const QuillEditorConfig(),\n  ),\n)\n```\n\nDispose of the `QuillController` in the `dispose` method:\n\n```dart\n@override\nvoid dispose() {\n  _controller.dispose();\n  super.dispose();\n}\n```\n\nCheck out [Sample Page] for more advanced usage.\n\n## 🔤 Input / Output\n\nThis library utilizes [Quill Delta](https://quilljs.com/docs/delta/) to represent document content.\nThe Delta format is a compact and versatile method for describing document changes through a series of operations that denote insertions, deletions, or formatting changes.\n\n* Use `_controller.document.toDelta()` to extract the deltas.\n* Use `_controller.document.toPlainText()` to extract plain text.\n\n**To save the document**:\n\n```dart\nfinal String json = jsonEncode(_controller.document.toDelta().toJson());\n// Stores the JSON Quill Delta\n```\n\n**To load the document**:\n\n```dart\nfinal String json = ...; // Load the previously stored JSON Quill Delta\n\n_controller.document = Document.fromJson(jsonDecode(json));\n```\n\n**To change the read-only mode**:\n\n```dart\n_controller.readOnly = true; // Or false to allow edit\n```\n\n### 🔗 Links\n\n- [🪶 Quill Delta](https://quilljs.com/docs/delta/)\n- [📜 Quill Delta Formats](https://quilljs.com/docs/formats)\n\n## ⚙️ Configurations\n\nThe `QuillSimpleToolbar` and `QuillEditor` widgets are both customizable.\n[Sample Page] provides sample code for advanced usage and configuration.\n\n### 🔗 Links\n\n- [🛠️ Using Custom App Widget](./doc/configurations/using_custom_app_widget.md)\n- [🌍 Localizations Setup](./doc/configurations/localizations_setup.md)\n- [🔠 Font Size](./doc/configurations/font_size.md)\n- [🖋 Font Family](#-font-family)\n- [🔘 Custom Toolbar buttons](./doc/configurations/custom_buttons.md)\n- [🔍 Search](./doc/configurations/search.md)\n- [✂️ Shortcut events](./doc/customizing_shortcuts.md)\n- [🎨 Custom Toolbar](./doc/custom_toolbar.md)\n\n### 🖋 Font Family\n\nTo use your own fonts, update your [Assets](./example/assets/fonts) directory and pass in `items` to `QuillToolbarFontFamilyButton`'s options.\nMore details\non [this commit](https://github.com/singerdmx/flutter-quill/commit/71d06f6b7be1b7b6dba2ea48e09fed0d7ff8bbaa),\n[this article](https://stackoverflow.com/questions/55075834/fontfamily-property-not-working-properly-in-flutter)\nand [this](https://www.flutterbeads.com/change-font-family-flutter/).\n\n## 📦 Embed Blocks\n\nThe `flutter_quill` package provides an interface for all the users to provide their own implementations for embed\nblocks.\n\nRefer to the [Custom Embed Blocks](./doc/custom_embed_blocks.md) for more details.\n\n### 🛠️ Using the embed blocks from `flutter_quill_extensions`\n\nThe [`flutter_quill_extensions`][FlutterQuill Extensions]\npackage provide implementations for image and video embed blocks.\n\n## 🔄 Delta Conversion\n\n\u003e [!CAUTION]\n\u003e Storing the **Delta** as **HTML** in the database to convert it back to **Delta** when\n\u003e loading the document is not recommended due to the structural and functional differences between HTML and Delta ([see this comment](https://github.com/slab/quill/issues/1551#issuecomment-311458570)).\n\u003e We recommend storing the **Document** as **Delta JSON**\n\u003e instead of other formats (e.g., HTML, Markdown, PDF, Microsoft Word, Google Docs, Apple Pages, XML).\n\u003e\n\u003e Converting **Delta** from/to **HTML** is not a standard feature in [Quill JS](https://github.com/slab/quill)\n\u003e or [Flutter Quill][FlutterQuill].\n\nAvailable Packages for Conversion\n\n| Package | Description |\n| ------- | ----------- |\n| [`vsc_quill_delta_to_html`](https://pub.dev/packages/vsc_quill_delta_to_html) | Converts **Delta** to **HTML**. |\n| [`flutter_quill_delta_from_html`](https://pub.dev/packages/flutter_quill_delta_from_html) | Converts **HTML** to **Delta**. |\n| [`flutter_quill_to_pdf`](https://pub.dev/packages/flutter_quill_to_pdf) | Converts **Delta** to **PDF**. |\n| [`markdown_quill`](https://pub.dev/packages/markdown_quill) | Converts **Markdown** to **Delta** and vice versa. |\n| [`flutter_quill_delta_easy_parser`](https://pub.dev/packages/flutter_quill_delta_easy_parser) | Converts Quill **Delta** into a simplified document format, making it easier to manage and manipulate text attributes. |\n\n\u003e [!TIP]\n\u003e You might want to convert between **HTML** and **Delta** for some use cases:\n\u003e\n\u003e 1. **Migration**: If you're using an existing system that stores the data in HTML and want to convert the document\n     data to **Delta**.\n\u003e 2. **Sharing**: For example, if you want to share the Document **Delta** somewhere or send it as an email.\n\u003e 3. **Save as**: If your app has a feature that allows converting Documents to other formats.\n\u003e 4. **Rich text pasting**: If you copy some content from websites or apps, and want to paste it into the app.\n\u003e 5. **SEO**: In case you want to use HTML for SEO support.\n\n## 📝 Rich Text Paste\n\nThis feature allows the user to paste the content copied from other apps into the editor as rich text.\nThe plugin [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge) provides access to the system Clipboard.\n\n\u003cp\u003e\n  \u003cimg src=\"https://github.com/singerdmx/flutter-quill/blob/master/example/assets/images/rich_text_paste.gif?raw=true\"\n    alt=\"An animated image of the rich text paste on macOS\" width=\"600\" /\u003e\n\u003c/p\u003e\n\n\u003e [!IMPORTANT]\n\u003e Currently this feature is unsupported on the web.\n\u003e See [issue #1998](https://github.com/singerdmx/flutter-quill/issues/1998) and [issue #2220](https://github.com/singerdmx/flutter-quill/issues/2220)\n for more details.\n\n## 🌐 Translation\n\nThe package offers translations for the toolbar and editor widgets, it will follow the system locale unless you set your\nown locale.\n\nSee the [translation](./doc/translation.md) page for more info.\n\n## 🧪 Testing\n\nTake a look at [flutter_quill_test](https://pub.dev/packages/flutter_quill_test) for testing.\n\nCurrently, the support for testing is limited.\n\n## 🤝 Contributing\n\n\u003e [!IMPORTANT]\n\u003e At this time, we prioritize bug fixes and code quality improvements over new features. \n\u003e Please refrain from submitting large changes to add new features, as they might\n\u003e not be merged, and exceptions may made.\n\u003e We encourage you to create an issue or reach out beforehand, \n\u003e explaining your proposed changes and their rationale for a higher chance of acceptance. Thank you!\n\nWe greatly appreciate your time and effort.\n\nTo keep the project consistent and maintainable, we have a few guidelines that we ask all contributors to follow.\nThese guidelines help ensure that everyone can understand and work with the code easier.\n\nSee [Contributing](./CONTRIBUTING.md) for more details.\n\n## 📜 Acknowledgments\n\n- Special thanks to everyone who has contributed to this project...\n  \u003cbr\u003e\u003cbr\u003e\n  \u003ca href=\"https://github.com/singerdmx/flutter-quill/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=singerdmx/flutter-quill\" alt=\"Contributors\"/\u003e\n  \u003c/a\u003e\n\n    \u003cbr\u003e\n\n  Made with [contrib.rocks](https://contrib.rocks).\n\n- Thanks to the welcoming community, the volunteers who helped along the journey, developers, contributors\n  and contributors who put time and effort into everything including making all the libraries, tools, and the\n  information we rely on\n- We are incredibly grateful to many individuals and organizations who have played a\n  role in the project.\n  This includes the welcoming community, dedicated volunteers, talented developers and\n  contributors, and the creators of the open-source tools we rely on.\n\n[Quill]: https://quilljs.com/docs/formats\n\n[Flutter]: https://github.com/flutter/flutter\n\n[FlutterQuill]: https://pub.dev/packages/flutter_quill\n\n[FlutterQuill Extensions]: https://pub.dev/packages/flutter_quill_extensions\n\n[ReactQuill]: https://github.com/zenoamaro/react-quill\n\n[Youtube Playlist]: https://youtube.com/playlist?list=PLbhaS_83B97vONkOAWGJrSXWX58et9zZ2\n\n[Slack Group]: https://join.slack.com/t/bulletjournal1024/shared_invite/zt-fys7t9hi-ITVU5PGDen1rNRyCjdcQ2g\n\n[Sample Page]: https://github.com/singerdmx/flutter-quill/blob/master/example/lib/main.dart\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsingerdmx%2Fflutter-quill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsingerdmx%2Fflutter-quill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsingerdmx%2Fflutter-quill/lists"}