feat: add forceUpdate api #263

Hufe921 · Aug 27, 2023 · bc2f445 · bc2f445
1 parent 9fcbecc
commit bc2f445
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 0 deletions.
diff --git a/docs/en/guide/command-execute.md b/docs/en/guide/command-execute.md
@@ -79,6 +79,16 @@ Usage:
 instance.command.executeSetRange(startIndex: number , endIndex: number)
 ```
 
+## executeForceUpdate
+
+Feature: force update editor
+
+Usage:
+
+```javascript
+instance.command.executeForceUpdate(options?: IForceUpdateOption)
+```
+
 ## executeUndo
 
 Feature: Undo
@@ -755,9 +765,11 @@ instance.command.executeWordTool()
 ```
 
 ## executeSetHTML
+
 Feature: Set the editor HTML data
 
 Usage:
+
 ```javascript
 instance.command.executeSetHTML(payload: Partial<IEditorHTML)
 ```

diff --git a/docs/guide/command-execute.md b/docs/guide/command-execute.md
@@ -79,6 +79,16 @@ instance.command.executeBackspace()
 instance.command.executeSetRange(startIndex: number , endIndex: number)
 ```
 
+## executeForceUpdate
+
+功能：强制重新渲染文档
+
+用法：
+
+```javascript
+instance.command.executeForceUpdate(options?: IForceUpdateOption)
+```
+
 ## executeUndo
 
 功能：撤销

diff --git a/src/editor/core/command/Command.ts b/src/editor/core/command/Command.ts
@@ -9,6 +9,7 @@ export class Command {
   public executeSelectAll: CommandAdapt['selectAll']
   public executeBackspace: CommandAdapt['backspace']
   public executeSetRange: CommandAdapt['setRange']
+  public executeForceUpdate: CommandAdapt['forceUpdate']
   public executeUndo: CommandAdapt['undo']
   public executeRedo: CommandAdapt['redo']
   public executePainter: CommandAdapt['painter']
@@ -103,6 +104,7 @@ export class Command {
     this.executeSelectAll = adapt.selectAll.bind(adapt)
     this.executeBackspace = adapt.backspace.bind(adapt)
     this.executeSetRange = adapt.setRange.bind(adapt)
+    this.executeForceUpdate = adapt.forceUpdate.bind(adapt)
     // 撤销、重做、格式刷、清除格式
     this.executeUndo = adapt.undo.bind(adapt)
     this.executeRedo = adapt.redo.bind(adapt)

diff --git a/src/editor/core/command/CommandAdapt.ts b/src/editor/core/command/CommandAdapt.ts
@@ -21,6 +21,7 @@ import { DeepRequired } from '../../interface/Common'
 import {
   IAppendElementListOption,
   IDrawImagePayload,
+  IForceUpdateOption,
   IGetImageOption,
   IGetValueOption,
   IPainterOption
@@ -156,6 +157,15 @@ export class CommandAdapt {
     })
   }
 
+  public forceUpdate(options?: IForceUpdateOption) {
+    const { isSubmitHistory = false } = options || {}
+    this.range.clearRange()
+    this.draw.render({
+      isSubmitHistory,
+      isSetCursor: false
+    })
+  }
+
   public undo() {
     const isReadonly = this.draw.isReadonly()
     if (isReadonly) return

diff --git a/src/editor/interface/Draw.ts b/src/editor/interface/Draw.ts
@@ -12,6 +12,10 @@ export interface IDrawOption {
   isSourceHistory?: boolean
 }
 
+export interface IForceUpdateOption {
+  isSubmitHistory?: boolean
+}
+
 export interface IDrawImagePayload {
   width: number
   height: number