@kaitify/core 0.0.2-beta.17 → 0.0.2-beta.18

package/lib/model/Editor.d.ts

@@ -124,7 +124,7 @@ export type EditorConfigureOptionType = {
      */
     onInsertParagraph?: (this: Editor, node: KNode) => void;
     /**
-     * 完成删除时触发
+     * 完成删除回调，此时还没有对起点和终点进行合并操作，也没有进行判空操作
      */
     onDeleteComplete?: (this: Editor) => void;
     /**
@@ -293,7 +293,7 @@ export declare class Editor {
      */
     onInsertParagraph?: (this: Editor, node: KNode) => void;
     /**
-     * 完成删除时触发【初始化后不可修改】
+     * 完成删除回调，此时还没有对起点和终点进行合并操作，也没有进行判空操作【初始化后不可修改】
      */
     onDeleteComplete?: (this: Editor) => void;
     /**

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;
     /**

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

@@ -18,7 +18,7 @@ export declare const fomratBlockTagParse: RuleFunctionType;
  */
 export declare const formatBlockInChildren: RuleFunctionType;
 /**
- * 针对节点自身：处理不可编辑的非块级节点：在两侧添加零宽度空白字符 & 重置不可编辑节点内的光标位置
+ * 针对节点自身：处理不可编辑的可见的非块级节点：在两侧添加零宽度空白字符 & 重置不可编辑节点内的光标位置
  */
 export declare const formatUneditableNoodes: RuleFunctionType;
 /**

package/package.json

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