|
@@ -17,7 +17,7 @@ and the Flutter guide for
|
|
|
|
|
|
|
|
|
<div align="center">
|
|
|
- <img src="https://raw.githubusercontent.com/LucasXu0/AppFlowy/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/documentation/images/example.png" width = "900"/>
|
|
|
+ <img src="https://raw.githubusercontent.com/LucasXu0/AppFlowy/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/documentation/images/example.png" width = "900"/>
|
|
|
</div>
|
|
|
|
|
|
## Features
|
|
@@ -30,13 +30,13 @@ and the Flutter guide for
|
|
|
* Test-covered
|
|
|
* Current code coverage >= 63%, we will still continue to add more test cases.
|
|
|
|
|
|
-> Due to the extensible structure and the increase in functionality, we encourage each commit to add test case code under test to ensure that the other committer does not have to worry about their code affecting the existing logic as much as possible. For more testing information, please check [TESTING.md](https://github.com/LucasXu0/AppFlowy/blob/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/documentation/testing.md)
|
|
|
+> Due to the extensible structure and the increase in functionality, we encourage each commit to add test case code under test to ensure that the other committer does not have to worry about their code affecting the existing logic as much as possible. For more testing information, please check [TESTING.md](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/documentation/testing.md)
|
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
|
|
```shell
|
|
|
-flutter pub add flowy_editor
|
|
|
+flutter pub add appflowy_editor
|
|
|
flutter pub get
|
|
|
```
|
|
|
|
|
@@ -66,7 +66,7 @@ final editor = AppFlowyEditor(
|
|
|
For more. Run the example.
|
|
|
```shell
|
|
|
git clone https://github.com/AppFlowy-IO/AppFlowy.git
|
|
|
-cd frontend/app_flowy/packages/flowy_editor/example
|
|
|
+cd frontend/app_flowy/packages/appflowy_editor/example
|
|
|
flutter run
|
|
|
```
|
|
|
|
|
@@ -81,13 +81,13 @@ Please refer to [customizing a shortcut event](documentation/customizing.md#cust
|
|
|
|
|
|
## Code Examples
|
|
|
* Customizing a component.
|
|
|
- * [Checkbox Text](https://github.com/LucasXu0/AppFlowy/blob/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/lib/src/render/rich_text/checkbox_text.dart) - Showing how to extend new styles based on existing rich text components.
|
|
|
- * [Image](https://github.com/LucasXu0/AppFlowy/blob/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/example/lib/plugin/image_node_widget.dart) - Showing how to extend a new node and render it.
|
|
|
- * More examples. [Rich text plugins](https://github.com/LucasXu0/AppFlowy/tree/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/lib/src/render/rich_text)
|
|
|
+ * [Checkbox Text](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/checkbox_text.dart) - Showing how to extend new styles based on existing rich text components.
|
|
|
+ * [Image](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/example/lib/plugin/image_node_widget.dart) - Showing how to extend a new node and render it.
|
|
|
+ * More examples. [Rich text plugins](https://github.com/LucasXu0/AppFlowy/tree/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text)
|
|
|
* Customizing a shortcut event.
|
|
|
- * [BIUS](https://github.com/LucasXu0/AppFlowy/blob/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart) - Showing how to make text bold/italic/underline/strikethrough through shortcut keys
|
|
|
- * [Paste HTML](https://github.com/LucasXu0/AppFlowy/blob/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/lib/src/service/internal_key_event_handlers/copy_paste_handler.dart) - Showing how to handle pasted styles through shortcut keys
|
|
|
- * More examples. [Internal key event handlers](https://github.com/LucasXu0/AppFlowy/tree/documentation/flowy_editor/frontend/app_flowy/packages/flowy_editor/lib/src/service/internal_key_event_handlers)
|
|
|
+ * [BIUS](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart) - Showing how to make text bold/italic/underline/strikethrough through shortcut keys
|
|
|
+ * [Paste HTML](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/copy_paste_handler.dart) - Showing how to handle pasted styles through shortcut keys
|
|
|
+ * More examples. [Internal key event handlers](https://github.com/LucasXu0/AppFlowy/tree/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers)
|
|
|
|
|
|
## Glossary
|
|
|
We are working on more detailed instructions, for now please refer to the API documentation.
|