💡 docs(pro-editor): 补充store 相关公共方法注释

ant-design · Jun 14, 2023 · 77ccfe1 · 77ccfe1
1 parent 62238b9
commit 77ccfe1
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 1 deletion.
diff --git a/src/ProEditor/store/slices/canvas.ts b/src/ProEditor/store/slices/canvas.ts
@@ -34,13 +34,26 @@ const initialCanvasState: CanvasSliceState = {
 };
 
 export interface CanvasPublicAction {
+  /**
+   * 取消选中 Canvas
+   */
   deselectCanvas: () => void;
+  /**
+   * 更新视口
+   * @param viewPort - 视口的部分属性
+   */
   updateViewport: (viewPort: Partial<Viewport>) => void;
+  /**
+   * 更新 Canvas 交互状态
+   * @param interaction - 交互状态
+   * @param action - 用户操作的部分参数
+   */
   updateCanvasInteraction: (
     interaction: InteractStatus,
     action?: Partial<UserActionParams>,
   ) => void;
 }
+
 export interface CanvasSlice extends CanvasPublicAction, CanvasSliceState {
   internalUpdateCanvasInteract: (
     interaction: InteractStatus,

diff --git a/src/ProEditor/store/slices/config.ts b/src/ProEditor/store/slices/config.ts
@@ -48,12 +48,24 @@ export interface ActionOptions {
   payload?: Partial<UserActionParams>;
 }
 
+/**
+ * 公共配置操作接口
+ */
 export interface ConfigPublicAction {
   /**
    * 导出配置
    */
   exportConfig: () => void;
+  /**
+   * 重置配置
+   */
   resetConfig: () => void;
+  /**
+   * 更新配置
+   * @template T - 配置对象类型
+   * @param {Partial<T>} config - 需要更新的配置对象
+   * @param {ActionOptions} [options] - 配置项
+   */
   updateConfig: <T>(config: Partial<T>, options?: ActionOptions) => void;
 }
 

diff --git a/src/ProEditor/store/slices/configPanel.ts b/src/ProEditor/store/slices/configPanel.ts
@@ -11,6 +11,7 @@ export interface ConfigPanelPublicAction {
    */
   togglePanelExpand: (nextExpandState?: boolean) => void;
 }
+
 export interface ConfigPanelSlice extends ConfigPanelPublicAction {
   updatePanelPosition: (position: Partial<Position>) => void;
   updatePanelSize: (sizeDelta: Partial<NumberSize>) => void;

diff --git a/src/ProEditor/store/slices/general.ts b/src/ProEditor/store/slices/general.ts
@@ -31,13 +31,27 @@ const initialGeneralState: GeneralSliceState = {
 
 // ======== action ======== //
 
+/**
+ * 通用公共动作
+ */
 export interface GeneralPublicAction {
+  /**
+   * 撤销操作
+   */
   undo: () => void;
+  /**
+   * 重做操作
+   */
   redo: () => void;
+  /**
+   * 撤销栈
+   */
   undoStack: () => StackItem[];
+  /**
+   * 重做栈
+   */
   redoStack: () => StackItem[];
 }
-
 export interface GeneralSlice extends GeneralPublicAction, GeneralSliceState {}
 
 export const generalSlice: StateCreator<