Преглед на файлове

feat(doc): document's state

Vincent Chan преди 2 години
родител
ревизия
f0ed15440a
променени са 1 файла, в които са добавени 9 реда и са изтрити 0 реда
  1. 9 0
      frontend/app_flowy/packages/flowy_editor/lib/src/editor_state.dart

+ 9 - 0
frontend/app_flowy/packages/flowy_editor/lib/src/editor_state.dart

@@ -26,6 +26,15 @@ enum CursorUpdateReason {
   others,
 }
 
+/// The state of the editor.
+///
+/// The state including:
+/// - The document to render
+/// - The state of the selection.
+///
+/// [EditorState] also includes the services of the editor:
+/// - Selection service
+/// - Scroll service
 class EditorState {
   final StateTree document;