mirror of
https://github.com/AppFlowy-IO/AppFlowy.git
synced 2024-08-30 18:12:39 +00:00
feat: #1649 add document for importing data
This commit is contained in:
parent
2fb0e8da28
commit
50f9ac1657
@ -60,7 +60,7 @@ final editor = AppFlowyEditor(
|
||||
);
|
||||
```
|
||||
|
||||
You can also create an editor from a JSON object in order to configure your initial state.
|
||||
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](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/documentation/importing.md).
|
||||
|
||||
```dart
|
||||
final json = ...;
|
||||
@ -79,7 +79,7 @@ MaterialApp(
|
||||
);
|
||||
```
|
||||
|
||||
To get a sense for how the AppFlowy Editor works, run our example:
|
||||
To get a sense of how the AppFlowy Editor works, run our example:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/AppFlowy-IO/AppFlowy.git
|
||||
|
@ -0,0 +1,36 @@
|
||||
# Importing data
|
||||
|
||||
For now, we have supported three ways to import data to initialize AppFlowy Editor.
|
||||
|
||||
1. From AppFlowy Document JSON
|
||||
|
||||
```dart
|
||||
const document = r'''{"document":{"type":"editor","children":[{"type":"text","attributes":{"subtype":"heading","heading":"h1"},"delta":[{"insert":"Hello AppFlowy!"}]}]}}''';
|
||||
final json = jsonDecode(document);
|
||||
final editorState = EditorState(
|
||||
document: Document.fromJson(
|
||||
Map<String, Object>.from(json),
|
||||
),
|
||||
);
|
||||
```
|
||||
|
||||
2. From Markdown
|
||||
|
||||
```dart
|
||||
const markdown = r'''# Hello AppFlowy!''';
|
||||
final editorState = EditorState(
|
||||
document: markdownToDocument(markdown),
|
||||
);
|
||||
```
|
||||
|
||||
3. From Quill Delta
|
||||
|
||||
```dart
|
||||
const delta = r'''[{"insert":"Hello AppFlowy!"},{"attributes":{"header":1},"insert":"\n"}]''';
|
||||
final json = jsonDecode(delta);
|
||||
final editorState = EditorState(
|
||||
document: DeltaDocumentConvert().convertFromJSON(json),
|
||||
);
|
||||
```
|
||||
|
||||
For more details, please refer to the function `_importFile` through this [link](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/example/lib/home_page.dart).
|
Loading…
x
Reference in New Issue
Block a user