- Dart 98.2%
- C++ 0.8%
- CMake 0.7%
- Ruby 0.1%
- HTML 0.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
b1e7853608* chore: enable additional lint rules and update dependencies Enable new lint rules including no_equal_then_else, no_equal_conditions, avoid_contradictory_expressions, and resource cleanup rules. Update awesome_lints dependency to use local path reference. * fix: add missing dispose calls for proper resource cleanup Add dispose() calls for controllers, notifiers, and other resources across multiple components to prevent memory leaks. Also fix parameter type in table_node.dart and collection equality check in scroll service. * refactor: remove deprecated document and node classes Delete deprecated DocumentV0 and NodeV0 classes and remove the deprecated Document.empty() factory method in favor of Document.blank(). * fix: remove deprecated exports and duplicate lint ignores Remove exports for deleted deprecated document and node files from core.dart and remove duplicate dispose_fields ignore comments. * chore: point awesome_lints to git main branch Change awesome_lints dependency from local path to git repository reference pointing to main branch. * fix: remove duplicate dispose calls in find replace widget Remove duplicate findTextEditingController.dispose() call and remove searchService.dispose() from FindMenu since it doesn't own the service. The searchService is owned and disposed by the parent widget. * fix: correct overlay entry disposal in toolbar widgets Remove overlay entries from overlay before disposing. OverlayEntry must be removed with remove() before dispose() is called. Move cleanup logic to proper order in dispose methods. * refactor: inline overlay cleanup logic in toolbar dispose methods Replace helper method calls with inline cleanup logic to make the overlay entry disposal order explicit (remove, dispose, set to null). |
||
| .github | ||
| assets | ||
| documentation | ||
| example | ||
| lib | ||
| test | ||
| .fvmrc | ||
| .gitignore | ||
| analysis_options.yaml | ||
| CHANGELOG.md | ||
| codecov.yml | ||
| LICENSE | ||
| pubspec.yaml | ||
| README.md | ||
AppFlowy Editor
A highly customizable rich-text editor for Flutter
Key Features
- Build rich, intuitive editors
- Design and modify an ever-expanding list of customizable features including
- block components (such as form input controls, numbered lists, and rich text widgets)
- shortcut events
- themes
- selection menu
- toolbar menu
- Test Coverage and ongoing maintenance by AppFlowy's core team and community of more than 1,000 builders
| Preview | Customize your own theme |
|---|---|
 |
 |
| Change the color of your text | Format your text |
|---|---|
 |
 |
Getting Started
Add the AppFlowy editor Flutter package to your environment.
flutter pub add appflowy_editor
flutter pub get
Creating Your First Editor
Start by creating a new empty AppFlowyEditor object.
final editorState = EditorState.blank(withInitialText: true); // with an empty paragraph
final editor = AppFlowyEditor(
editorState: editorState,
);
You 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.
final json = jsonDecode('YOUR INPUT JSON STRING');
final editorState = EditorState(document: Document.fromJson(json));
final editor = AppFlowyEditor(
editorState: editorState,
);
Note: The parameters
localizationsDelegatesneed to be assigned in MaterialApp widget
MaterialApp(
localizationsDelegates: const [
AppFlowyEditorLocalizations.delegate,
]，
);
To get a sense of how the AppFlowy Editor works, run our example:
git clone https://github.com/AppFlowy-IO/appflowy-editor.git
flutter pub get
flutter run
Customizing Your Editor
Customizing theme
Please refer to our documentation on customizing AppFlowy for a detailed discussion about customizing theme.
- See further examples of how AppFlowy custom the theme
Customizing Block Components
Please refer to our documentation on customizing AppFlowy for a detailed discussion about customizing components.
Below are some examples of component customizations:
- Todo List Block Component demonstrates how to extend new styles based on existing rich text components
- Divider Block Component demonstrates how to extend a new block component and render it
- See further examples of AppFlowy
Customizing Shortcut Events
Please refer to our documentation on customizing AppFlowy for a detailed discussion about customizing shortcut events.
Below are some examples of shortcut event customizations:
- BIUS demonstrates how to make text bold/italic/underline/strikethrough through shortcut keys
- Need more examples? Check out shortcuts
Migration Guide
Please refer to the migration documentation.
Glossary
Please refer to the API documentation.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Please look at CONTRIBUTING.md for details.
License
All code contributed to the AppFlowy Editor project is dual-licensed, and released under both of the following licenses:
- The GNU Affero General Public License Version 3
- The Mozilla Public License, Version 2.0 (the “MPL”)
See LICENSE for more information.