@kaitify/core 0.0.2-beta.9 → 0.0.2

package/lib/model/Editor.d.ts

@@ -124,7 +124,7 @@ export type EditorConfigureOptionType = {
      */
     onInsertParagraph?: (this: Editor, node: KNode) => void;
     /**
-     * 完成删除时触发
+     * 完成删除回调，此时还没有对起点和终点进行合并操作，也没有进行判空操作
      */
     onDeleteComplete?: (this: Editor) => void;
     /**
@@ -167,6 +167,10 @@ export type EditorConfigureOptionType = {
      * 编辑器updateView执行时，通过比对新旧节点数组获取需要格式化的节点，在这些节点被格式化前，触发此方法，回调参数即当前需要被格式化的节点，该方法返回一个节点，返回的节点将会被格式化，如果你不需要任何特殊处理，返回入参提供的节点即可
      */
     onBeforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
+    /**
+     * 编辑器进行光标纠正时触发，在这里可以修改虚拟光标的位置
+     */
+    onRedressSelection?: (this: Editor) => void;
     /**
      * 编辑器的初始默认值
      */
@@ -289,7 +293,7 @@ export declare class Editor {
      */
     onInsertParagraph?: (this: Editor, node: KNode) => void;
     /**
-     * 完成删除时触发【初始化后不可修改】
+     * 完成删除回调，此时还没有对起点和终点进行合并操作，也没有进行判空操作【初始化后不可修改】
      */
     onDeleteComplete?: (this: Editor) => void;
     /**
@@ -332,6 +336,10 @@ export declare class Editor {
      * 编辑器updateView执行时，通过比对新旧节点数组获取需要格式化的节点，在这些节点被格式化前，触发此方法，回调参数即当前需要被格式化的节点，该方法返回一个节点，返回的节点将会被格式化，如果你不需要任何特殊处理，返回入参提供的节点即可【初始化后不可修改】
      */
     onBeforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
+    /**
+     * 编辑器进行光标纠正时触发，在这里可以修改虚拟光标的位置
+     */
+    onRedressSelection?: (this: Editor) => void;
     /**
      * 唯一id【不可修改】【open】
      */
@@ -373,13 +381,27 @@ export declare class Editor {
      */
     scrollViewToSelection(): void;
     /**
-     * 根据dom查找到编辑内的对应节点
+     * 根据dom查找到编辑内的对应节点。如果是闭合节点内的dom，此时可能无标记或者无对应的节点，则会向上查找，最终找到闭合节点并返回
      */
     findNode(dom: HTMLElement): KNode;
     /**
      * 根据编辑器内的node查找真实dom
      */
     findDom(node: KNode): HTMLElement;
+    /**
+     * 判断某个dom是否在闭合节点对应的真实dom之内。
+     * - includeSelf 为 true（默认）时，闭合节点的根 dom 自身也算"在内"；
+     * - includeSelf 为 false 时，只有闭合节点内部的子孙 dom 才算"在内"，根 dom 自身返回 false。
+     */
+    isDomInClosedNode(el: HTMLElement, includeSelf?: boolean): boolean;
+    /**
+     * 获取光标所在的闭合节点，仅当光标在闭合节点的两侧，即offset分别是0和1时，才会返回该闭合节点
+     */
+    getClosedNodeBySelection(options?: KNodeMatchOptionType): KNode | null;
+    /**
+     * 判断光标范围内是否有闭合节点，必须完整包含的闭合节点才会被返回在内
+     */
+    hasClosedNodeBySelection(options?: KNodeMatchOptionType): boolean;
     /**
      * 设置编辑器是否可编辑
      */

package/lib/model/KNode.d.ts

@@ -77,18 +77,21 @@ export declare class KNode {
      */
     marks?: KNodeMarksType;
     /**
-     * 样式集合，样式名称请使用驼峰写法，虽然在渲染时兼容处理了中划线格式的样式名称，但是在其他地方可能会出现问题并且编辑器内部在样式相关的判断都是以驼峰写法为主【可以修改】
+     * 样式集合【可以修改】
+     * 样式名称请使用驼峰写法，虽然在渲染时兼容处理了中划线格式的样式名称，但是在其他地方可能会出现问题并且编辑器内部在样式相关的判断都是以驼峰写法为主
      */
     styles?: KNodeStylesType;
     /**
-     * 是否锁定节点【可以修改】：
-     * 针对块节点，在符合合并条件的情况下是否允许编辑器将其与父节点或者子节点进行合并；
-     * 针对行内节点，在符合合并条件的情况下是否允许编辑器将其与相邻节点或者父节点或者子节点进行合并；
-     * 针对文本节点，在符合合并的条件下是否允许编辑器将其与相邻节点或者父节点进行合并。
+     * 是否锁定节点，锁定的节点都不允许合并【可以修改】：
+     * - 针对块节点，在符合合并条件的情况下是否允许编辑器将其与父节点或者子节点进行合并；
+     * - 针对行内节点，在符合合并条件的情况下是否允许编辑器将其与相邻节点或者父节点或者子节点进行合并；
+     * - 针对文本节点，在符合合并的条件下是否允许编辑器将其与相邻节点或者父节点进行合并。
      */
     locked: boolean;
     /**
-     * 是否为固定块节点，值为true时：当光标在节点起始处或者光标在节点内只有占位符时，执行删除操作不会删除此节点，会再次创建一个占位符进行处理；当光标在节点内且节点不是代码块样式，不会进行换行【可以修改】
+     * 是否为固定块节点，值为true时：
+     * - 当光标在节点起始处或者光标在节点内只有占位符时，执行删除操作不会删除此节点，会再次创建一个占位符进行处理；
+     * - 当光标在节点内且节点不是代码块样式，不会进行换行【可以修改】
      */
     fixed: boolean;
     /**
@@ -96,7 +99,9 @@ export declare class KNode {
      */
     nested: boolean;
     /**
-     * 是否为不可见节点，意味着此类节点在编辑器内视图内无法看到
+     * 是否为不可见节点
+     * - 编辑器在处理节点时会忽略此类节点
+     * - 通常意味着无法看到的或者无法编辑的
      */
     void?: boolean;
     /**
@@ -163,10 +168,6 @@ export declare class KNode {
      * 【API】是否含有样式
      */
     hasStyles(): boolean;
-    /**
-     * 【API】判断节点是否不可编辑的，如果是返回设置不可编辑的那个节点，否则返回null
-     */
-    getUneditable(): KNode | null;
     /**
      * 【API】当前节点是否只包含占位符
      */

package/lib/model/config/event-handler.d.ts

@@ -14,7 +14,7 @@ export declare const onComposition: (this: Editor, e: Event) => Promise<void>;
 /**
  * 监听键盘事件
  */
-export declare const onKeyboard: (this: Editor, e: Event) => void;
+export declare const onKeyboard: (this: Editor, e: Event) => Promise<void>;
 /**
  * 监听编辑器获取焦点
  */

package/lib/model/config/format-rules.d.ts

@@ -7,20 +7,20 @@ export type RuleFunctionType = (state: {
     editor: Editor;
     node: KNode;
 }) => void;
+/**
+ * 针对节点自身：将带有 contenteditable="false" 标记的节点统一转为闭合节点，并移除该标记（渲染时由框架统一添加）
+ */
+export declare const formatContenteditableToClosed: RuleFunctionType;
 /**
  * 针对节点自身：处理块节点的标签，部分块节点需要转为默认块节点标签
  */
-export declare const fomratBlockTagParse: RuleFunctionType;
+export declare const formatBlockTagParse: RuleFunctionType;
 /**
  * 针对子节点中的块节点：
  * 1. 子节点中含有块节点则该节点转为块节点；
  * 2. 子节点中含有块节点，则其他节点也转为块节点
  */
 export declare const formatBlockInChildren: RuleFunctionType;
-/**
- * 针对节点自身：处理不可编辑的非块级节点：在两侧添加零宽度空白字符 & 重置不可编辑节点内的光标位置
- */
-export declare const formatUneditableNoodes: RuleFunctionType;
 /**
  * 针对节点的子节点数组：处理子节点中的占位符，如果占位符和其他节点共存则删除占位符，如果只存在占位符则将多个占位符合并为一个（光标可能会更新）
  */

package/lib/model/config/function.d.ts

@@ -43,9 +43,9 @@ export declare const registerExtension: (this: Editor, extension: Extension) =>
  */
 export declare const updateSelection: (this: Editor) => boolean;
 /**
- * 纠正光标位置，返回布尔值表示是否存在纠正行为
+ * 纠正光标位置
  */
-export declare const redressSelection: (this: Editor) => boolean;
+export declare const redressSelection: (this: Editor) => void;
 /**
  * 初始化校验编辑器的节点数组，如果编辑器的节点数组为空或者都是空节点，则初始化创建一个只有占位符的段落
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@kaitify/core",
-	"version": "0.0.2-beta.9",
+	"version": "0.0.2",
 	"private": false,
 	"type": "module",
 	"author": "so-better",