ht-emr 0.6.2 → 0.6.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -40,21 +40,79 @@ import { AreaMode } from './dataset/enum/Area';
40
40
  import { IBadge } from './interface/Badge';
41
41
  import { WatermarkType } from './dataset/enum/Watermark';
42
42
  import { INTERNAL_SHORTCUT_KEY } from './dataset/constant/Shortcut';
43
+ /**
44
+ * Canvas编辑器主类
45
+ *
46
+ * 这是编辑器的入口点,提供:
47
+ * - 编辑器实例创建和销毁
48
+ * - 命令执行接口(通过command属性)
49
+ * - 事件监听和事件总线
50
+ * - 插件扩展机制
51
+ *
52
+ * @example
53
+ * ```typescript
54
+ * const editor = new Editor(container, data, options);
55
+ * editor.command.executeBold(); // 执行加粗命令
56
+ * editor.listener.contentChange = () => { }; // 监听内容变化
57
+ * editor.destroy(); // 销毁编辑器
58
+ * ```
59
+ */
43
60
  export default class Editor {
61
+ /** 命令执行器,提供所有编辑操作的接口 */
44
62
  command: Command;
63
+ /** 编辑器版本号 */
45
64
  version: string;
65
+ /** 事件监听器,用于设置各种回调函数 */
46
66
  listener: Listener;
67
+ /** 事件总线,用于发布/订阅编辑器事件 */
47
68
  eventBus: EventBus<EventBusMap>;
69
+ /** 覆盖器,用于自定义内部行为 */
48
70
  override: Override;
71
+ /** 注册器,用于注册自定义菜单、快捷键等 */
49
72
  register: Register;
73
+ /** 销毁编辑器的方法 */
50
74
  destroy: () => void;
75
+ /** 插件使用方法 */
51
76
  use: UsePlugin;
77
+ /** 核心渲染引擎 */
52
78
  private draw;
79
+ /**
80
+ * 创建编辑器实例
81
+ *
82
+ * @param container - 编辑器容器元素
83
+ * @param data - 编辑器数据,可以是元素数组或包含header/main/footer的对象
84
+ * @param options - 编辑器配置选项
85
+ */
53
86
  constructor(container: HTMLDivElement, data: IEditorData | IElement[], options?: IEditorOption);
87
+ /**
88
+ * 设置表单模式追踪选项
89
+ * @param payload - 表单模式追踪配置
90
+ */
54
91
  setFormModeTrace(payload: IFormModeTraceOption): void;
92
+ /**
93
+ * 暂停用户交互
94
+ *
95
+ * 调用后编辑器将不响应用户输入事件。
96
+ */
55
97
  pauseInteraction(): void;
98
+ /**
99
+ * 恢复用户交互
100
+ *
101
+ * 恢复编辑器对用户输入事件的响应。
102
+ */
56
103
  resumeInteraction(): void;
104
+ /**
105
+ * 设置覆盖层激活状态
106
+ *
107
+ * 当外部模态框、下拉菜单等覆盖层打开时调用。
108
+ *
109
+ * @param payload - 是否激活
110
+ */
57
111
  setOverlayActive(payload: boolean): void;
112
+ /**
113
+ * 暂停/恢复全局快捷键
114
+ * @param payload - true暂停,false恢复
115
+ */
58
116
  suspendGlobalShortcut(payload: boolean): void;
59
117
  }
60
118
  export { splitText, createDomFromElementList, getElementListByHTML, getTextFromElementList };
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "ht-emr",
3
3
  "author": "swj",
4
4
  "license": "MIT",
5
- "version": "0.6.2",
5
+ "version": "0.6.4",
6
6
  "description": "rich text editor by canvas/svg",
7
7
  "publishConfig": {
8
8
  "registry": "https://registry.npmjs.org/",