{"id":19614619,"url":"https://github.com/appflowy-io/appflowy-editor","last_synced_at":"2025-05-14T19:06:48.314Z","repository":{"id":65697747,"uuid":"595584495","full_name":"AppFlowy-IO/appflowy-editor","owner":"AppFlowy-IO","description":"A highly customizable rich-text editor for Flutter. The AppFlowy Editor project for AppFlowy and beyond.","archived":false,"fork":false,"pushed_at":"2025-04-02T04:53:46.000Z","size":27023,"stargazers_count":532,"open_issues_count":90,"forks_count":220,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-13T13:19:38.894Z","etag":null,"topics":["flutter","flutter-apps","flutter-examples","flutter-package","flutter-plugin","flutter-widget","rich-text-editor"],"latest_commit_sha":null,"homepage":"https://pub.dev/packages/appflowy_editor","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AppFlowy-IO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2023-01-31T11:45:04.000Z","updated_at":"2025-04-12T22:49:16.000Z","dependencies_parsed_at":"2023-11-02T13:37:09.475Z","dependency_job_id":"a9add7a3-9ddd-4012-979e-532e4770b22b","html_url":"https://github.com/AppFlowy-IO/appflowy-editor","commit_stats":null,"previous_names":[],"tags_count":53,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AppFlowy-IO%2Fappflowy-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AppFlowy-IO","download_url":"https://codeload.github.com/AppFlowy-IO/appflowy-editor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248717657,"owners_count":21150440,"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":["flutter","flutter-apps","flutter-examples","flutter-package","flutter-plugin","flutter-widget","rich-text-editor"],"created_at":"2024-11-11T10:53:07.890Z","updated_at":"2025-04-13T13:19:54.088Z","avatar_url":"https://github.com/AppFlowy-IO.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nThis README describes the package. If you publish this package to pub.dev,\nthis README's contents appear on the landing page for your package.\n\nFor information about how to write a good package README, see the guide for\n[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).\n\nFor general information about developing packages, see the Dart guide for\n[creating packages](https://dart.dev/guides/libraries/create-library-packages)\nand the Flutter guide for\n[developing packages and plugins](https://flutter.dev/developing-packages).\n--\u003e\n\n\u003ch1 align=\"center\"\u003e\u003cb\u003eAppFlowy Editor\u003c/b\u003e\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eA highly customizable rich-text editor for Flutter\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://discord.gg/ZCCYN4Anzq\"\u003e\u003cb\u003eDiscord\u003c/b\u003e\u003c/a\u003e •\n    \u003ca href=\"https://twitter.com/appflowy\"\u003e\u003cb\u003eTwitter\u003c/b\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://codecov.io/github/AppFlowy-IO/appflowy-editor\" \u003e\n        \u003cimg src=\"https://codecov.io/github/AppFlowy-IO/appflowy-editor/branch/main/graph/badge.svg?token=BXTGUXTWRU\"/\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/images/showcase.png?raw=true\" width = \"700\" style = \"padding: 100\"\u003e\n\u003c/div\u003e\n\n## Key Features\n\n* Build rich, intuitive editors\n* Design and modify an ever-expanding list of customizable features including\n  * block components (such as form input controls, numbered lists, and rich text widgets)\n  * shortcut events\n  * themes\n  * selection menu\n  * toolbar menu\n* [Test Coverage](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/testing.md) and ongoing maintenance by AppFlowy's core team and community of more than 1,000 builders\n\n| Preview                | Customize your own theme   |\n| ---------------------- | ------------------------   |\n| ![Preview](documentation/images/preview.jpg) | ![Customize your own theme](documentation/images/theme.jpg) |\n\n| Change the color of your text       | Format your text   |\n| ---------------------- | ----------------------     |\n| ![Color](documentation/images/color.jpg) | ![Format](documentation/images/format.jpg) |\n\n\n## Getting Started\n\nAdd the AppFlowy editor [Flutter package](https://docs.flutter.dev/development/packages-and-plugins/using-packages) to your environment.\n\n```shell\nflutter pub add appflowy_editor\nflutter pub get\n```\n\n## Creating Your First Editor\n\nStart by creating a new empty AppFlowyEditor object.\n\n```dart\nfinal editorState = EditorState.blank(withInitialText: true); // with an empty paragraph\nfinal editor = AppFlowyEditor(\n  editorState: editorState,\n);\n```\n\nYou can also create an editor from a JSON object in order to configure your initial state. Or you can [create an editor from Markdown or Quill Delta](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/importing.md).\n\n```dart\nfinal json = jsonDecode('YOUR INPUT JSON STRING');\nfinal editorState = EditorState(document: Document.fromJson(json));\nfinal editor = AppFlowyEditor(\n  editorState: editorState,\n);\n```\n\n\u003e Note: The parameters `localizationsDelegates` need to be assigned in MaterialApp widget\n```dart\nMaterialApp(\n  localizationsDelegates: const [\n    AppFlowyEditorLocalizations.delegate,\n  ]，\n);\n```\n\nTo get a sense of how the AppFlowy Editor works, run our example:\n\n```shell\ngit clone https://github.com/AppFlowy-IO/appflowy-editor.git\nflutter pub get\nflutter run\n```\n\n## Customizing Your Editor\n\n### Customizing theme\n\nPlease refer to our documentation on customizing AppFlowy for a detailed discussion about [customizing theme](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/customizing.md#customizing-a-theme).\n\n * See further examples of [how AppFlowy custom the theme](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_style.dart)\n\n### Customizing Block Components\n\nPlease refer to our documentation on customizing AppFlowy for a detailed discussion about [customizing components](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/customizing.md#customize-a-component).\n\nBelow are some examples of component customizations:\n\n * [Todo List Block Component](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/lib/src/editor/block_component/todo_list_block_component/todo_list_block_component.dart) demonstrates how to extend new styles based on existing rich text components\n * [Divider Block Component](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/lib/src/editor/block_component/divider_block_component/divider_block_component.dart) demonstrates how to extend a new block component and render it\n * See further examples of [AppFlowy](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/appflowy_flutter/lib/plugins/document/presentation/editor_page.dart)\n\n### Customizing Shortcut Events\n\nPlease refer to our documentation on customizing AppFlowy for a detailed discussion about [customizing shortcut events](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/customizing.md#customize-a-shortcut-event).\n\nBelow are some examples of shortcut event customizations:\n\n * [BIUS](https://github.com/AppFlowy-IO/appflowy-editor/tree/main/lib/src/editor/editor_component/service/shortcuts/character_shortcut_events/format_single_character) demonstrates how to make text bold/italic/underline/strikethrough through shortcut keys\n * Need more examples? Check out [shortcuts](https://github.com/AppFlowy-IO/appflowy-editor/tree/main/lib/src/editor/editor_component/service/shortcuts)\n\n## Migration Guide\nPlease refer to the [migration documentation](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/UPGRADING.md).\n\n## Glossary\nPlease refer to the API documentation.\n\n## Contributing\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.\n\nPlease look at [CONTRIBUTING.md](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy) for details.\n\n## License\nAll code contributed to the AppFlowy Editor project is dual-licensed, and released under both of the following licenses:\n1. The GNU Affero General Public License Version 3\n2. The Mozilla Public License, Version 2.0 (the “MPL”)\n\nSee [LICENSE](https://github.com/AppFlowy-IO/appflowy-editor/blob/main/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappflowy-io%2Fappflowy-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappflowy-io%2Fappflowy-editor/lists"}