From f0ed15440a887390fe18cc1e7d68cc3a03ee4cbd Mon Sep 17 00:00:00 2001
From: Vincent Chan <okcdz@diverse.space>
Date: Fri, 12 Aug 2022 14:00:56 +0800
Subject: [PATCH] feat(doc): document's state

---
 .../packages/flowy_editor/lib/src/editor_state.dart      | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/frontend/app_flowy/packages/flowy_editor/lib/src/editor_state.dart b/frontend/app_flowy/packages/flowy_editor/lib/src/editor_state.dart
index 31a321a3c0..4b387afd9e 100644
--- a/frontend/app_flowy/packages/flowy_editor/lib/src/editor_state.dart
+++ b/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;