From 3b43ebdcfdcb834a1c8a9419e1754011d870e60d Mon Sep 17 00:00:00 2001 From: "Lucas.Xu" Date: Wed, 12 Jul 2023 12:16:57 +0800 Subject: [PATCH] chore: add migration guide --- README.md | 3 +++ documentation/migration.md | 9 +++++++++ 2 files changed, 12 insertions(+) create mode 100644 documentation/migration.md diff --git a/README.md b/README.md index 1cab4caa2..0d0d3b2da 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,9 @@ Below are some examples of shortcut event customizations: * [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 * Need more examples? Check out [shortcuts](https://github.com/AppFlowy-IO/appflowy-editor/tree/main/lib/src/editor/editor_component/service/shortcuts) +## Migration Guide +Please refer to the [migration documentation]((https://github.com/AppFlowy-IO/appflowy-editor/blob/main/documentation/migration.md)). + ## Glossary Please refer to the API documentation. diff --git a/documentation/migration.md b/documentation/migration.md new file mode 100644 index 000000000..47faa352a --- /dev/null +++ b/documentation/migration.md @@ -0,0 +1,9 @@ +# Migration Guide + +## From 1.1.0 to 1.2.0 + +- `AppFlowyEditor.custom` and `AppFlowyEditor.standard` have been removed. Use `AppFlowyEditor.` instead. + - For now, we provide the default values to the blockComponentBuilders, characterShortcutEvents, and commandShortcutEvents if you do not customize them. +- `DefaultSelectable` has been renamed to `DefaultSelectableMixin` +- `FlowyRichText` has been renamed to `AppFlowyRichText`. +- Added new parameter called `context`(BuildContext) into`TextSpanDecoratorForAttribute`. \ No newline at end of file