engine-basic
# Engine Basic
词量: 3401 | 阅读时长: 18分钟
# 目录
# Engine 概览
# EngineOptions
export type EngineOptions = {
/**
* 本地化语言，默认 zh-CN
*/
lang?: string;
/**
* 本地化语言
*/
locale?: { [key: string]: {} };
/**
* 样式名称
*/
className?: string;
/**
* tab 键的索引
*/
tabIndex?: number;
/**
* 根节点
*/
root?: Node;
/**
* 滚动条节点，查找父级样式 overflow 或者 overflow-y 为 auto 或者 scroll 的节点
*/
scrollNode?: Node | (() => Node | null);
/**
* 插件配置
*/
plugins?: Array<PluginEntry>;
/**
* 卡片配置
*/
cards?: Array<CardEntry>;
/**
* 插件的可选项
*/
config?: { [k: string]: PluginOptions };
/**
* 占位内容
*/
placeholder?: string;
/**
* 是否只读
*/
readonly?: boolean;
/**
* 懒惰渲染卡片（仅限已启用 lazyRender 的卡片），默认为 true
*/
lazyRender?: boolean;
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# Engine
export interface Engine {
/**
* 构造函数
*/
new (selector: Selector, options?: EngineOptions): EngineInterface;
}
export interface EngineInterface extends EditorInterface {
/**
* 选项
*/
options: EngineOptions;
/**
* 是否只读
*/
readonly: boolean;
/**
* 编辑器更改
*/
change: ChangeInterface;
/**
* 按键处理
*/
typing: TypingInterface;
/**
* 协同编辑
*/
ot: OTInterface;
/**
* 历史记录
*/
history: HistoryInterface;
/**
* 快捷键
*/
hotkey: HotkeyInterface;
/**
* 聚焦到编辑器
*/
focus(toStart?: boolean): void;
/**
* 让编辑器失去焦点
*/
blur(): void;
/**
* 是否聚焦到编辑器
*/
isFocus(): boolean;
/**
* 是否为空内容
*/
isEmpty(): boolean;
/**
* 设置滚动节点
* @param node 节点
*/
setScrollNode(node: HTMLElement): void;
/**
* 获取编辑器值
* @param ignoreCursor 是否包含光标位置信息
*/
getValue(ignoreCursor?: boolean): string;
/**
* 异步获取编辑器值，将等候插件处理完成后再获取值
* 比如插件上传等待中，将等待上传完成后再获取值
* @param ignoreCursor 是否包含光标位置信息，默认不包含
* @param callback 有插件还有动作未执行完时回调，返回 false 终止获取值，返回 number 设置当前动作等待时间，毫秒
*/
getValueAsync(
ignoreCursor?: boolean,
callback?: (
name: string,
card?: CardInterface,
...args: any
) => boolean | number | void,
): Promise<string>;
/**
* 获取编辑器的html
*/
getHtml(): string;
/**
* 设置编辑器值
* @param value 值
* @param callback 异步渲染卡片后的回调
*/
setValue(
value: string,
callback?: (count: number) => void,
): EngineInterface;
/**
* 设置html，会格式化为合法的编辑器值
* @param html html
* @param callback 异步渲染卡片后的回调
*/
setHtml(html: string, callback?: (count: number) => void): EngineInterface;
/**
* 设置json格式值，主要用于协同
* @param callback 异步渲染卡片后的回调
*/
setJsonValue(
value: Array<any>,
callback?: (count: number) => void,
): EngineInterface;
/**
* 获取JSON格式的值
*/
getJsonValue(): string | undefined | (string | {})[];
/**
* 展示 placeholder
*/
showPlaceholder(): void;
/**
* 隐藏 placeholder
*/
hidePlaceholder(): void;
/**
* 绑定事件
* @param eventType 事件类型
* @param listener 事件回调
* @param rewrite 是否重写
*/
on(eventType: string, listener: EventListener, rewrite?: boolean): void;
/**
* 全选ctrl+a键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:all',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 卡片最小化时触发
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(
eventType: 'card:minimize',
listener: (card: CardInterface) => void,
rewrite?: boolean,
): void;
/**
* 卡片最大化时触发
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(
eventType: 'card:maximize',
listener: (card: CardInterface) => void,
rewrite?: boolean,
): void;
/**
* 解析DOM节点，生成符合标准的 XML 代码之前触发
* @param root DOM节点
*/
on(
eventType: 'parse:value-before',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* 解析DOM节点，生成符合标准的 XML，遍历子节点时触发。返回false跳过当前节点
* @param node 当前遍历的节点
* @param attributes 当前节点已过滤后的属性
* @param styles 当前节点已过滤后的样式
* @param value 当前已经生成的xml代码
*/
on(
eventType: 'parse:value',
listener: (
node: NodeInterface,
attributes: { [key: string]: string },
styles: { [key: string]: string },
value: Array<string>,
) => boolean | void,
rewrite?: boolean,
): void;
/**
* 解析DOM节点，生成符合标准的 XML。生成xml代码结束后触发
* @param value xml代码
*/
on(
eventType: 'parse:value-after',
listener: (value: Array<string>) => void,
rewrite?: boolean,
): void;
/**
* 转换为HTML代码之前触发
* @param root 需要转换的根节点
*/
on(
eventType: 'parse:html-before',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* 转换为HTML代码
* @param root 需要转换的根节点
*/
on(
eventType: 'parse:html',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* 转换为HTML代码之后触发
* @param root 需要转换的根节点
*/
on(
eventType: 'parse:html-after',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* 当粘贴到编辑器事件发生时触发，返回false，将不在处理粘贴
* @param data 粘贴板相关数据
* @param source 粘贴的富文本
*/
on(
eventType: 'paste:event',
listener: (
data: ClipboardData & { isPasteText: boolean },
source: string,
) => boolean | void,
rewrite?: boolean,
): void;
/**
* 设置本次粘贴所需保留标签的白名单，以及属性
* @param schema 标签白名单管理实例
*/
on(
eventType: 'paste:schema',
listener: (schema: SchemaInterface) => void,
rewrite?: boolean,
): void;
/**
* 解析粘贴数据，还未生成符合编辑器数据的片段之前触发
* @param root 粘贴的DOM节点
*/
on(
eventType: 'paste:origin',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* 解析粘贴数据，生成符合编辑器数据的片段之后扁平化阶段触发
* @param node 粘贴片段遍历的子节点
*/
on(
eventType: 'paste:each',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* 解析粘贴数据，生成符合编辑器数据的片段之后扁平化阶段触发
* @param node 所有粘贴片段遍历后的根节点
*/
on(
eventType: 'paste:each-after',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* 生成粘贴数据DOM片段后，还未写入到编辑器之前触发
* @param fragment 粘贴的片段
*/
on(
eventType: 'paste:before',
listener: (fragment: DocumentFragment) => void,
rewrite?: boolean,
): void;
/**
* 插入当前粘贴的片段后触发，此时还未渲染卡片
* @param range 当前插入后的光标实例
*/
on(
eventType: 'paste:insert',
listener: (range: RangeInterface) => void,
rewrite?: boolean,
): void;
/**
* 粘贴完成后触发
*/
on(eventType: 'paste:after', listener: () => void, rewrite?: boolean): void;
/**
* 复制DOM节点时触发
* @param node 当前遍历的子节点
*/
on(
eventType: 'copy',
listener: (root: NodeInterface) => void,
rewrite?: boolean,
): void;
/**
* DOM改变触发
* @param eventType
* @param ops
*/
on(
eventType: 'ops',
listener: (ops: Op[]) => void,
rewrite?: boolean,
): void;
/**
* 移除绑定事件
* @param eventType 事件类型
* @param listener 事件回调
*/
off(eventType: string, listener: EventListener): void;
/**
* 全选ctrl+a键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:all',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 卡片最小化时触发
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(
eventType: 'card:minimize',
listener: (card: CardInterface) => void,
): void;
/**
* 卡片最大化时触发
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(
eventType: 'card:maximize',
listener: (card: CardInterface) => void,
): void;
/**
* 解析DOM节点，生成符合标准的 XML 代码之前触发
* @param root DOM节点
*/
off(
eventType: 'parse:value-before',
listener: (root: NodeInterface) => void,
): void;
/**
* 解析DOM节点，生成符合标准的 XML，遍历子节点时触发。返回false跳过当前节点
* @param node 当前遍历的节点
* @param attributes 当前节点已过滤后的属性
* @param styles 当前节点已过滤后的样式
* @param value 当前已经生成的xml代码
*/
off(
eventType: 'parse:value',
listener: (
node: NodeInterface,
attributes: { [key: string]: string },
styles: { [key: string]: string },
value: Array<string>,
) => boolean | void,
): void;
/**
* 解析DOM节点，生成符合标准的 XML。生成xml代码结束后触发
* @param value xml代码
*/
off(
eventType: 'parse:value-after',
listener: (value: Array<string>) => void,
): void;
/**
* 转换为HTML代码之前触发
* @param root 需要转换的根节点
*/
off(
eventType: 'parse:html-before',
listener: (root: NodeInterface) => void,
): void;
/**
* 转换为HTML代码
* @param root 需要转换的根节点
*/
off(eventType: 'parse:html', listener: (root: NodeInterface) => void): void;
/**
* 转换为HTML代码之后触发
* @param root 需要转换的根节点
*/
off(
eventType: 'parse:html-after',
listener: (root: NodeInterface) => void,
): void;
/**
* 当粘贴到编辑器事件发生时触发，返回false，将不在处理粘贴
* @param data 粘贴板相关数据
* @param source 粘贴的富文本
*/
off(
eventType: 'paste:event',
listener: (
data: ClipboardData & { isPasteText: boolean },
source: string,
) => boolean | void,
): void;
/**
* 设置本次粘贴所需保留标签的白名单，以及属性
* @param schema 标签白名单管理实例
*/
off(
eventType: 'paste:schema',
listener: (schema: SchemaInterface) => void,
): void;
/**
* 解析粘贴数据，还未生成符合编辑器数据的片段之前触发
* @param root 粘贴的DOM节点
*/
off(
eventType: 'paste:origin',
listener: (root: NodeInterface) => void,
): void;
/**
* 解析粘贴数据，生成符合编辑器数据的片段之后扁平化阶段触发
* @param node 粘贴片段遍历的子节点
*/
off(eventType: 'paste:each', listener: (root: NodeInterface) => void): void;
/**
* 解析粘贴数据，生成符合编辑器数据的片段之后扁平化阶段触发
* @param node 所有粘贴片段遍历后的根节点
*/
off(
eventType: 'paste:each-after',
listener: (root: NodeInterface) => void,
): void;
/**
* 生成粘贴数据DOM片段后，还未写入到编辑器之前触发
* @param fragment 粘贴的片段
*/
off(
eventType: 'paste:before',
listener: (fragment: DocumentFragment) => void,
): void;
/**
* 插入当前粘贴的片段后触发，此时还未渲染卡片
* @param range 当前插入后的光标实例
*/
off(
eventType: 'paste:insert',
listener: (range: RangeInterface) => void,
): void;
/**
* 粘贴完成后触发
*/
off(eventType: 'paste:after', listener: () => void): void;
/**
* 复制DOM节点时触发
* @param node 当前遍历的子节点
*/
off(eventType: 'copy', listener: (root: NodeInterface) => void): void;
/**
* DOM改变触发
* @param eventType
* @param ops
*/
off(eventType: 'ops', listener: (ops: Op[]) => void): void;
/**
* 触发事件
* @param eventType 事件名称
* @param args 触发参数
*/
trigger(eventType: string, ...args: any): any;
/**
* 全选ctrl+a键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:all', event: KeyboardEvent): boolean | void;
/**
* 卡片最小化时触发
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(eventType: 'card:minimize', card: CardInterface): void;
/**
* 卡片最大化时触发
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(eventType: 'card:maximize', card: CardInterface): void;
/**
* 解析DOM节点，生成符合标准的 XML 代码之前触发
* @param root DOM节点
*/
trigger(eventType: 'parse:value-before', root: NodeInterface): void;
/**
* 解析DOM节点，生成符合标准的 XML，遍历子节点时触发。返回false跳过当前节点
* @param node 当前遍历的节点
* @param attributes 当前节点已过滤后的属性
* @param styles 当前节点已过滤后的样式
* @param value 当前已经生成的xml代码
*/
trigger(
eventType: 'parse:value',
node: NodeInterface,
attributes: { [key: string]: string },
styles: { [key: string]: string },
value: Array<string>,
): boolean | void;
/**
* 解析DOM节点，生成符合标准的 XML。生成xml代码结束后触发
* @param value xml代码
*/
trigger(eventType: 'parse:value-after', value: Array<string>): void;
/**
* 转换为HTML代码之前触发
* @param root 需要转换的根节点
*/
trigger(eventType: 'parse:html-before', root: NodeInterface): void;
/**
* 转换为HTML代码
* @param root 需要转换的根节点
*/
trigger(eventType: 'parse:html', root: NodeInterface): void;
/**
* 转换为HTML代码之后触发
* @param root 需要转换的根节点
*/
trigger(eventType: 'parse:html-after', root: NodeInterface): void;
/**
* 当粘贴到编辑器事件发生时触发，返回false，将不在处理粘贴
* @param data 粘贴板相关数据
* @param source 粘贴的富文本
*/
trigger(
eventType: 'paste:event',
data: ClipboardData & { isPasteText: boolean },
source: string,
): boolean | void;
/**
* 设置本次粘贴所需保留标签的白名单，以及属性
* @param schema 标签白名单管理实例
*/
trigger(eventType: 'paste:schema', schema: SchemaInterface): void;
/**
* 解析粘贴数据，还未生成符合编辑器数据的片段之前触发
* @param root 粘贴的DOM节点
*/
trigger(eventType: 'paste:origin', root: NodeInterface): void;
/**
* 解析粘贴数据，生成符合编辑器数据的片段之后扁平化阶段触发
* @param node 粘贴片段遍历的子节点
*/
trigger(eventType: 'paste:each', root: NodeInterface): void;
/**
* 解析粘贴数据，生成符合编辑器数据的片段之后扁平化阶段触发
* @param node 所有粘贴片段遍历后的根节点
*/
trigger(eventType: 'paste:each-after', root: NodeInterface): void;
/**
* 生成粘贴数据DOM片段后，还未写入到编辑器之前触发
* @param fragment 粘贴的片段
*/
trigger(eventType: 'paste:before', fragment: DocumentFragment): void;
/**
* 插入当前粘贴的片段后触发，此时还未渲染卡片
* @param range 当前插入后的光标实例
*/
trigger(eventType: 'paste:insert', range: RangeInterface): void;
/**
* 粘贴完成后触发
*/
trigger(eventType: 'paste:after'): void;
/**
* 复制DOM节点时触发
* @param node 当前遍历的子节点
*/
trigger(eventType: 'copy', root: NodeInterface): void;
/**
* DOM改变触发
* @param eventType
* @param ops
*/
trigger(eventType: 'ops', ops: Op[]): void;
/**
* 回车键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:enter',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 删除键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:backspace',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* Tab键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:tab',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* Shift-Tab键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:shift-tab',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* @ 符合键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:at',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 空格键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:space',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 反斜杠键按下，唤出Toolbar，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:slash',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 左方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:left',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 右方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:right',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 上方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:up',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 下方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keydown:down',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 回车键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keyup:enter',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 删除键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keyup:backspace',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* Tab键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keyup:tab',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 空格键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'keyup:space',
listener: (event: KeyboardEvent) => boolean | void,
rewrite?: boolean,
): void;
/**
* 编辑器光标选择变化时触发
* @param eventType
* @param listener
* @param rewrite
*/
on(eventType: 'select', listener: () => void, rewrite?: boolean): void;
/**
* 编辑器值变化时触发
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'change',
listener: (value: string, trigger: 'remote' | 'local' | 'both') => void,
rewrite?: boolean,
): void;
/**
* 编辑器值有变化时就触发，与 change 相比，change 需要在组合输入法完成输入后才会触发，在一定时间内如果内容没有改版也不会触发 change
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'realtimeChange',
listener: (trigger: 'remote' | 'local') => void,
rewrite?: boolean,
): void;
/**
* 设置编辑器值之前
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(
eventType: 'beforeSetValue',
listener: (value: string) => void,
rewrite?: boolean,
): void;
/**
* 设置编辑器值之后
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'afterSetValue',
listener: () => void,
rewrite?: boolean,
): void;
/**
* 编辑器聚焦
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(eventType: 'focus', listener: () => void, rewrite?: boolean): void;
/**
* 编辑器失去焦点
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(eventType: 'blur', listener: () => void, rewrite?: boolean): void;
/**
* 编辑器只读切换时
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(
eventType: 'readonly',
listener: (readonly: boolean) => void,
rewrite?: boolean,
): void;
/**
* 执行命令之前
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(
eventType: 'beforeCommandExecute',
listener: (name: string, ...args: any) => void,
rewrite?: boolean,
): void;
/**
* 执行命令之后
* @param eventType
* @param listener name:插件名称、args:参数
* @param rewrite
*/
on(
eventType: 'afterCommandExecute',
listener: (name: string, ...args: any) => void,
rewrite?: boolean,
): void;
/**
* 拖动文件到编辑器时触发
* @param files 文件集合
*/
on(
eventType: 'drop:files',
listener: (files: Array<File>) => void,
rewrite?: boolean,
): void;
/**
* 历史撤销
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'undo',
listener: () => boolean | void,
rewrite?: boolean,
): void;
/**
* 历史重做
* @param eventType
* @param listener
* @param rewrite
*/
on(
eventType: 'redo',
listener: () => boolean | void,
rewrite?: boolean,
): void;
/**
* 回车键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:enter',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 删除键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:backspace',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* Tab键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:tab',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* Shift-Tab键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:shift-tab',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* @ 符合键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:at',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 空格键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:space',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 反斜杠键按下，唤出Toolbar，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:slash',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 左方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:left',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 右方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:right',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 上方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:up',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 下方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keydown:down',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 回车键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keyup:enter',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 删除键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keyup:backspace',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* Tab键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keyup:tab',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 空格键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
off(
eventType: 'keyup:space',
listener: (event: KeyboardEvent) => boolean | void,
): void;
/**
* 编辑器光标选择变化时触发
* @param eventType
* @param listener
*/
off(eventType: 'select', listener: () => void): void;
/**
* 编辑器值变化时触发
* @param eventType
* @param listener
*/
off(
eventType: 'change',
listener: (value: string, trigger: 'remote' | 'local' | 'both') => void,
): void;
/**
* 编辑器值有变化时就触发，与 change 相比，change 需要在组合输入法完成输入后才会触发，在一定时间内如果内容没有改版也不会触发 change
* @param eventType
* @param listener
* @param rewrite
*/
off(
eventType: 'realtimeChange',
listener: (trigger: 'remote' | 'local') => void,
): void;
/**
* 设置编辑器值之前
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(eventType: 'beforeSetValue', listener: (value: string) => void): void;
/**
* 设置编辑器值之后
* @param eventType
* @param listener
*/
off(eventType: 'afterSetValue', listener: () => void): void;
/**
* 编辑器聚焦
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(eventType: 'focus', listener: () => void): void;
/**
* 编辑器失去焦点
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(eventType: 'blur', listener: () => void): void;
/**
* 编辑器只读切换时
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(eventType: 'readonly', listener: (readonly: boolean) => void): void;
/**
* 执行命令之前
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(
eventType: 'beforeCommandExecute',
listener: (name: string, ...args: any) => void,
): void;
/**
* 执行命令之后
* @param eventType
* @param listener name:插件名称、args:参数
*/
off(
eventType: 'afterCommandExecute',
listener: (name: string, ...args: any) => void,
): void;
/**
* 拖动文件到编辑器时触发
* @param files 文件集合
*/
off(eventType: 'drop:files', listener: (files: Array<File>) => void): void;
/**
* 历史撤销
* @param eventType
* @param listener
*/
off(eventType: 'undo', listener: () => boolean | void): void;
/**
* 历史重做
* @param eventType
* @param listener
*/
off(eventType: 'redo', listener: () => boolean | void): void;
/**
* 回车键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:enter', event: KeyboardEvent): boolean | void;
/**
* 删除键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(
eventType: 'keydown:backspace',
event: KeyboardEvent,
): boolean | void;
/**
* Tab键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:tab', event: KeyboardEvent): boolean | void;
/**
* Shift-Tab键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(
eventType: 'keydown:shift-tab',
event: KeyboardEvent,
): boolean | void;
/**
* @ 符合键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:at', event: KeyboardEvent): boolean | void;
/**
* 空格键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:space', event: KeyboardEvent): boolean | void;
/**
* 反斜杠键按下，唤出Toolbar，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:slash', event: KeyboardEvent): boolean | void;
/**
* 左方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:left', event: KeyboardEvent): boolean | void;
/**
* 右方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:right', event: KeyboardEvent): boolean | void;
/**
* 上方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:up', event: KeyboardEvent): boolean | void;
/**
* 下方向键按下，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keydown:down', event: KeyboardEvent): boolean | void;
/**
* 回车键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keyup:enter', event: KeyboardEvent): boolean | void;
/**
* 删除键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keyup:backspace', event: KeyboardEvent): boolean | void;
/**
* Tab键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keyup:tab', event: KeyboardEvent): boolean | void;
/**
* 空格键按下弹起，返回false，终止处理其它监听
* @param eventType
* @param listener
*/
trigger(eventType: 'keyup:space', event: KeyboardEvent): boolean | void;
/**
* 编辑器光标选择变化时触发
* @param eventType
* @param listener
*/
trigger(eventType: 'select'): void;
/**
* 编辑器值变化时触发
* @param eventType
* @param listener
*/
trigger(
eventType: 'change',
value: string,
trigger: 'remote' | 'local' | 'both',
): void;
/**
* 编辑器值有变化时就触发，与 change 相比，change 需要在组合输入法完成输入后才会触发，在一定时间内如果内容没有改版也不会触发 change
* @param eventType
* @param listener
* @param rewrite
*/
trigger(
eventType: 'realtimeChange',
trigger: 'remote' | 'local' | 'both',
): void;
/**
* 设置编辑器值之前
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(eventType: 'beforeSetValue', value: string): void;
/**
* 设置编辑器值之后
* @param eventType
* @param listener
*/
trigger(eventType: 'afterSetValue'): void;
/**
* 编辑器聚焦
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(eventType: 'focus'): void;
/**
* 编辑器失去焦点
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(eventType: 'blur'): void;
/**
* 编辑器只读切换时
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(eventType: 'readonly', readonly: boolean): void;
/**
* 执行命令之前
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(
eventType: 'beforeCommandExecute',
name: string,
...args: any
): void;
/**
* 执行命令之后
* @param eventType
* @param listener name:插件名称、args:参数
*/
trigger(eventType: 'afterCommandExecute', name: string, ...args: any): void;
/**
* 拖动文件到编辑器时触发
* @param files 文件集合
*/
trigger(eventType: 'drop:files', files: Array<File>): void;
/**
* 历史撤销
* @param eventType
*/
trigger(eventType: 'undo'): void;
/**
* 历史重做
* @param eventType
*/
trigger(eventType: 'redo'): void;
/**
* 销毁
*/
destroy(): void;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
总结如下：
- 定义 class 的方法
通过定义构造函数的方法定义类。
interface {new(args: Args): Class}
1
- Engine Core 大致分为如下部分：
- options: 配置管理
- readonly：只读模式
- change：管理编辑器的更改
- typing：按键管理
- ot：协同编辑
- history：历史记录
- hotkey：快捷键管理
- event: 事件管理
- destroy：销毁实例
- value/html: 内容管理
编辑 (opens new window)
上次更新: 2022/04/28, 23:58:26
Gitalking ...