Canvas-Editor 编辑器历史记录控制功能解析

在富文本编辑器开发中，历史记录管理是一个核心功能，它直接影响用户体验和编辑器的行为控制。Canvas-Editor 项目近期针对历史记录控制功能进行了重要更新，为开发者提供了更灵活的操作方式。

历史记录管理的意义

历史记录功能允许用户通过撤销(undo)和重做(redo)操作来修改编辑内容。在大多数编辑场景中，这是必不可少的用户体验功能。然而，在某些特定场景下，开发者可能需要临时禁用历史记录功能：

1. 批量操作场景：当编辑器需要执行大量自动操作时（如大模型自动生成内容），记录每个操作会导致历史记录堆栈过大
2. 不可逆操作：某些操作完成后不应允许用户撤销
3. 性能优化：减少不必要的记录可以提升编辑器性能

Canvas-Editor 的解决方案

Canvas-Editor 提供了细粒度的历史记录控制方式，不是简单地开启/关闭整个历史记录系统，而是允许开发者在单个操作层面控制是否记录历史。

关键 API 参数

在 executeInsertElementList 方法中，新增了 isSubmitHistory 选项参数：

instance.command.executeInsertElementList(
  [
    {
      value: '1'
    }
  ],
  {
    isSubmitHistory: false  // 不将此操作记录到历史
  }
)

设计考量

这种设计比全局开关历史记录更加合理，因为：

1. 操作粒度控制：可以精确控制哪些操作需要记录，哪些不需要
2. 避免状态混乱：不会因为全局开关导致编辑器状态不一致
3. 更安全的实现：避免了内部状态被外部不当修改的风险

实际应用场景

1. AI 内容生成：当使用大模型自动生成内容时，可以设置 isSubmitHistory: false，这样用户无法撤销整个生成过程，只能编辑生成后的内容
2. 模板插入：插入预设模板时，通常不希望用户能撤销整个模板的插入
3. 批量格式修改：执行批量样式修改时，可以作为一个整体操作记录到历史中

实现建议

开发者在使用此功能时，应当：

1. 明确区分哪些操作需要记录历史，哪些不需要
2. 对于连续多个不记录历史的操作，考虑合并为一个事务
3. 在文档中明确标注哪些操作不会记录历史，避免用户困惑

这种精细化的历史记录控制方式为 Canvas-Editor 提供了更强大的编辑控制能力，特别适合需要与AI协同或自动化处理的复杂编辑场景。