@kaitify/core 0.0.1-beta.9 → 0.0.1

package/lib/model/Editor.d.ts

@@ -3,6 +3,21 @@ import { Selection } from './Selection';
 import { History } from './History';
 import { RuleFunctionType } from './config/format-rules';
 import { Extension } from '../extensions';
+/**
+ * 中文输入的记录数据类型
+ */
+export type EditorCompositionDataType = {
+    isInput: boolean;
+    oldHtml?: string;
+    newHtml?: string;
+};
+/**
+ * 非法dom更新数据类型
+ */
+export type EditorObserverUpdateDataType = {
+    elm: Node;
+    type: 'add' | 'remove' | 'update';
+};
 /**
  * 编辑器获取光标范围内节点数据的类型
  */
@@ -71,7 +86,7 @@ export type EditorConfigureOptionType = {
     /**
      * 自定义dom转为非文本节点的后续处理
      */
-    domParseNodeCallback?: (this: Editor, node: KNode) => KNode;
+    onDomParseNode?: (this: Editor, node: KNode) => KNode;
     /**
      * 视图渲染时触发，如果返回true则表示继续使用默认逻辑，返回false则不走默认逻辑，需要自定义渲染视图
      */
@@ -131,27 +146,27 @@ export type EditorConfigureOptionType = {
     /**
      * 节点粘贴保留标记的自定义方法
      */
-    pasteKeepMarks?: (this: Editor, node: KNode) => KNodeMarksType;
+    onPasteKeepMarks?: (this: Editor, node: KNode) => KNodeMarksType;
     /**
      * 节点粘贴保留样式的自定义方法
      */
-    pasteKeepStyles?: (this: Editor, node: KNode) => KNodeStylesType;
+    onPasteKeepStyles?: (this: Editor, node: KNode) => KNodeStylesType;
     /**
      * 视图更新前回调方法
      */
-    beforeUpdateView?: (this: Editor) => void;
+    onBeforeUpdateView?: (this: Editor) => void;
     /**
      * 视图更新后回调方法
      */
-    afterUpdateView?: (this: Editor) => void;
+    onAfterUpdateView?: (this: Editor) => void;
     /**
      * 在删除和换行操作中块节点从其父节点中抽离出去成为与父节点同级的节点后触发，如果返回true则表示继续使用默认逻辑，会将该节点转为段落，返回false则不走默认逻辑，需要自定义处理
      */
-    onDetachMentBlockFromParentCallback?: (this: Editor, node: KNode) => boolean;
+    onDetachMentBlockFromParent?: (this: Editor, node: KNode) => boolean;
     /**
      * 编辑器updateView执行时，通过比对新旧节点数组获取需要格式化的节点，在这些节点被格式化前，触发此方法，回调参数即当前需要被格式化的节点，该方法返回一个节点，返回的节点将会被格式化，如果你不需要任何特殊处理，返回入参提供的节点即可
      */
-    beforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
+    onBeforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
     /**
      * 编辑器的初始默认值
      */
@@ -228,7 +243,7 @@ export declare class Editor {
     /**
      * 自定义dom转为非文本节点的后续处理【初始化后不可修改】
      */
-    domParseNodeCallback?: (this: Editor, node: KNode) => KNode;
+    onDomParseNode?: (this: Editor, node: KNode) => KNode;
     /**
      * 视图渲染时触发，如果返回true则表示继续使用默认逻辑，返回false则不走默认逻辑，需要自定义渲染视图【初始化后不可修改】
      */
@@ -288,27 +303,27 @@ export declare class Editor {
     /**
      * 节点粘贴保留标记的自定义方法【初始化后不可修改】
      */
-    pasteKeepMarks?: (this: Editor, node: KNode) => KNodeMarksType;
+    onPasteKeepMarks?: (this: Editor, node: KNode) => KNodeMarksType;
     /**
      * 节点粘贴保留样式的自定义方法【初始化后不可修改】
      */
-    pasteKeepStyles?: (this: Editor, node: KNode) => KNodeStylesType;
+    onPasteKeepStyles?: (this: Editor, node: KNode) => KNodeStylesType;
     /**
      * 视图更新前回调方法【初始化后不可修改】
      */
-    beforeUpdateView?: (this: Editor) => void;
+    onBeforeUpdateView?: (this: Editor) => void;
     /**
      * 视图更新后回调方法【初始化后不可修改】
      */
-    afterUpdateView?: (this: Editor) => void;
+    onAfterUpdateView?: (this: Editor) => void;
     /**
      * 在删除和换行操作中块节点节点从其父节点中抽离出去成为与父节点同级的节点后触发，如果返回true则表示继续使用默认逻辑，会将该节点转为段落，返回false则不走默认逻辑，需要自定义处理【初始化后不可修改】
      */
-    onDetachMentBlockFromParentCallback?: (this: Editor, node: KNode) => boolean;
+    onDetachMentBlockFromParent?: (this: Editor, node: KNode) => boolean;
     /**
      * 编辑器updateView执行时，通过比对新旧节点数组获取需要格式化的节点，在这些节点被格式化前，触发此方法，回调参数即当前需要被格式化的节点，该方法返回一个节点，返回的节点将会被格式化，如果你不需要任何特殊处理，返回入参提供的节点即可【初始化后不可修改】
      */
-    beforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
+    onBeforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
     /**
      * 唯一id【不可修改】【open】
      */
@@ -334,17 +349,13 @@ export declare class Editor {
      */
     oldStackNodes: KNode[];
     /**
-     * 是否在输入中文【不可修改】
+     * 中文输入的记录数据【不可修改】
      */
-    isComposition: boolean;
+    compositionData: EditorCompositionDataType;
     /**
      * 是否编辑器内部渲染真实光标引起selctionChange事件【不可修改】
      */
     internalCauseSelectionChange: boolean;
-    /**
-     * 是否用户操作的删除行为，如果是用户操作的删除行为，则在处理不可编辑的节点是会删除该节点，如果是API调用的删除方法则走正常的删除逻辑【不可修改】
-     */
-    isUserDelection: boolean;
     /**
      * dom监听【不可修改】
      */
@@ -377,6 +388,10 @@ export declare class Editor {
      * 是否深色模式
      */
     isDark(): boolean;
+    /**
+     * 判断编辑器是否为空，这里的空指的是编辑器内只有一个段落，并且段落里只有占位符
+     */
+    isEmpty(): boolean;
     /**
      * dom转KNode
      */
@@ -408,11 +423,11 @@ export declare class Editor {
     /**
      * 获取某个节点内的最后一个可以设置光标点的节点，包括自身
      */
-    getLastSelectionNodeInChildren(node: KNode): KNode | null;
+    getLastSelectionNode(node: KNode): KNode | null;
     /**
      * 获取某个节点内的第一个可以设置光标点的节点，包括自身
      */
-    getFirstSelectionNodeInChildren(node: KNode): KNode | null;
+    getFirstSelectionNode(node: KNode): KNode | null;
     /**
      * 查找指定节点之前可以设置为光标点的非空节点，不包括自身
      */
@@ -436,7 +451,7 @@ export declare class Editor {
     /**
      * 判断光标是否在某个节点内，start表示只判断起点，end表示只判断终点，all表示起点和终点都判断
      */
-    isSelectionInNode(node: KNode, type?: 'all' | 'start' | 'end' | undefined): boolean;
+    isSelectionInTargetNode(node: KNode, type?: 'all' | 'start' | 'end' | undefined): boolean;
     /**
      * 获取光标选区内的节点数据
      */
@@ -466,7 +481,12 @@ export declare class Editor {
      */
     insertText(text: string): void;
     /**
-     * 向选区进行换行，如果所在块节点只有占位符并且块节点不是段落则会转为段落
+     * 向选区进行换行
+     * 1. 所在块节点只有占位符并且块节点不是段落则会转为段落
+     * 2. 非代码块样式内换行是插入换行符\n
+     * 2. 光标所在块节点是固定块节点，则无法换行
+     * 3. 光标所在块节点只有占位符，并且其存在父节点，且父节点不是固定块节点，会从父节点抽离到与父节点同级
+     * 4. 光标所在块节点只有占位符，并且不存在父节点，且不是段落，则会转为段落
      */
     insertParagraph(): void;
     /**
@@ -486,7 +506,9 @@ export declare class Editor {
      */
     updateRealSelection(): Promise<void>;
     /**
-     * 重新渲染编辑器视图，不会触发onChange
+     * 重新渲染编辑器视图
+     * 1. 不会触发onChange事件；
+     * 2. 不会渲染真实光标
      */
     review(value: string): Promise<void>;
     /**
@@ -494,9 +516,26 @@ export declare class Editor {
      */
     destroy(): void;
     /**
-     * 获取编辑器的纯文本内容
+     * 获取编辑器的纯文本内容，excludeBreak表示是否排除换行符\n，excludeZeroWidthText表示是否排除零宽度空白字符
+     */
+    getContent(excludeBreak?: boolean, excludeZeroWidthText?: boolean): string;
+    /**
+     * 获取编辑器的html内容，该方法会返回一个包含style标签和div标签的html内容。自行展示html内容时可保证样式与编辑器一致，但是对于附件等有交互事件的元素交互事件会失效
+     * cssText用于自定义哪些样式需要保留
+     */
+    getHTML(filterCssText?: (cssText: string) => boolean): string;
+    /**
+     * 判断光标是否完全在可视范围内
+     */
+    isSelectionInView(): boolean;
+    /**
+     * 移除对编辑器的dom监听
+     */
+    removeDomObserve(): void;
+    /**
+     * 设置对编辑器的dom监听，主要解决非法dom插入问题
      */
-    getContent(): string;
+    setDomObserve(): void;
     /**
      * 配置编辑器，返回创建的编辑器
      */

package/lib/model/KNode.d.ts

@@ -44,7 +44,7 @@ export type KNodeCreateOptionType = {
     children?: KNodeCreateOptionType[];
 };
 /**
- * 创建零宽度无断空白文本节点的入参类型
+ * 创建零宽度空白文本节点的入参类型
  */
 export type ZeroWidthTextKNodeCreateOptionType = {
     marks?: KNodeMarksType;
@@ -148,7 +148,7 @@ export declare class KNode {
      */
     isEmpty(): boolean;
     /**
-     * 【API】是否零宽度无断空白文本节点
+     * 【API】是否零宽度空白文本节点
      */
     isZeroWidthText(): boolean;
     /**
@@ -184,7 +184,7 @@ export declare class KNode {
      */
     isEqualMarks(node: KNode): boolean;
     /**
-     * 【API】判断当前节点是否在拥有代码块样式的块级节点内（包括自身）
+     * 【API】判断当前节点是否在拥有代码块样式的块级节点内（包括自身），是的话返回该块级节点，否则返回null
      */
     isInCodeBlockStyle(): KNode | null;
     /**
@@ -206,11 +206,11 @@ export declare class KNode {
     /**
      * 【API】如果当前节点是文本节点或者闭合节点，则判断是不是指定节点后代中所有文本节点和闭合节点中的第一个
      */
-    firstTextClosedInNode: (node: KNode) => boolean;
+    firstInTargetNode: (node: KNode) => boolean;
     /**
      * 【API】如果当前节点是文本节点或者闭合节点，则判断是不是指定节点后代中所有文本节点和闭合节点中的最后一个
      */
-    lastTextClosedInNode(node: KNode): boolean;
+    lastInTargetNode(node: KNode): boolean;
     /**
      * 【API】获取当前节点在某个节点数组中的前一个非空节点
      */
@@ -228,7 +228,10 @@ export declare class KNode {
      */
     getMatchNode(options: KNodeMatchOptionType): KNode | null;
     /**
-     * 【API】获取当前节点下的所有可聚焦的节点，如果自身符合也会包括在内，type是all获取闭合节点和文本节点，type是closed获取闭合节点，type是text获取文本节点
+     * 【API】获取当前节点下的所有可聚焦的节点，如果自身符合也会包括在内
+     * 1. type 是 all 获取闭合节点和文本节点；
+     * 2. type 是 closed 获取闭合节点；
+     * 3. type 是 text 获取文本节点
      */
     getFocusNodes: (type?: "all" | "closed" | "text" | undefined) => KNode[];
     /**
@@ -236,7 +239,7 @@ export declare class KNode {
      */
     static create(options: KNodeCreateOptionType): KNode;
     /**
-     * 【API】创建零宽度无断空白文本节点
+     * 【API】创建零宽度空白文本节点
      */
     static createZeroWidthText(options?: ZeroWidthTextKNodeCreateOptionType): KNode;
     /**

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

@@ -12,11 +12,13 @@ export type RuleFunctionType = (state: {
  */
 export declare const fomratBlockTagParse: RuleFunctionType;
 /**
- * 针对子节点中的块节点：行内节点的子节点中含有块节点则该节点转为块节点；子节点中的其他节点也转为块节点
+ * 针对子节点中的块节点：
+ * 1. 子节点中含有块节点则该节点转为块节点；
+ * 2. 子节点中含有块节点，则其他节点也转为块节点
  */
 export declare const formatBlockInChildren: RuleFunctionType;
 /**
- * 针对节点自身：处理不可编辑的非块级节点：在两侧添加零宽度无断空白字符 & 重置不可编辑节点内的光标位置
+ * 针对节点自身：处理不可编辑的非块级节点：在两侧添加零宽度空白字符 & 重置不可编辑节点内的光标位置
  */
 export declare const formatUneditableNoodes: RuleFunctionType;
 /**
@@ -24,7 +26,15 @@ export declare const formatUneditableNoodes: RuleFunctionType;
  */
 export declare const formatPlaceholderMerge: RuleFunctionType;
 /**
- * 针对节点自身：将文本节点内连续的零宽度无断空白字符合并（光标可能会更新）
+ * 针对节点自身：
+ * 1. 统一将文本节点内的\r\n换成\n，解决Windows兼容问题
+ * 2. 统一将文本节点内的 （\u00A0）换成普通空格
+ * 3. 统一将文本节点内的零宽度无断空格换成零宽度空格（\uFEFF -> \u200B）
+ * 4. 统一将文本节点内的\n后面加上零宽度空白字符
+ */
+export declare const formatLineBreakSpaceText: RuleFunctionType;
+/**
+ * 针对节点自身：将文本节点内连续的零宽度空白字符合并（光标可能会更新）
  */
 export declare const formatZeroWidthTextMerge: RuleFunctionType;
 /**

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

@@ -59,7 +59,7 @@ export declare const handlerForPasteKeepMarksAndStyles: (this: Editor, nodes: KN
  */
 export declare const handlerForPasteFiles: (this: Editor, files: FileList) => Promise<void>;
 /**
- * 处理某个节点数组，针对为空的块级节点补充占位符
+ * 处理某个节点数组，针对为空的块级节点补充占位符，目前仅用于粘贴处理
  */
 export declare const fillPlaceholderToEmptyBlock: (this: Editor, nodes: KNode[]) => void;
 /**
@@ -71,7 +71,7 @@ export declare const handlerForPasteDrop: (this: Editor, dataTransfer: DataTrans
  */
 export declare const removeBlockFromParentToSameLevel: (this: Editor, node: KNode) => void;
 /**
- * 光标所在的块节点不是只有占位，且非固定块节点，非代码块样式的块节点，在该块节点内正常换行方法
+ * 光标所在的块节点不是只有占位符，且非固定块节点，非代码块样式的块节点，在该块节点内正常换行方法
  */
 export declare const handlerForNormalInsertParagraph: (this: Editor) => void;
 /**

package/lib/tools/index.d.ts

@@ -8,11 +8,11 @@ export declare const createUniqueKey: () => number;
  */
 export declare const createGuid: () => number;
 /**
- * 判断字符串是否零宽度无断空白字符
+ * 判断字符串是否零宽度空白字符
  */
 export declare const isZeroWidthText: (val: string) => boolean;
 /**
- * 获取一个零宽度无断空白字符
+ * 获取一个零宽度空白字符
  */
 export declare const getZeroWidthText: () => string;
 /**
@@ -47,3 +47,11 @@ export declare const delay: (num?: number | undefined) => Promise<void>;
  * 删除对象的某个属性
  */
 export declare const deleteProperty: <T>(val: any, propertyName: string) => T;
+/**
+ * 键盘Tab是否按下
+ */
+export declare const isOnlyTab: (e: KeyboardEvent) => boolean;
+/**
+ * 键盘Tab和shift是否一起按下
+ */
+export declare const isTabWithShift: (e: KeyboardEvent) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@kaitify/core",
-	"version": "0.0.1-beta.9",
+	"version": "0.0.1",
 	"private": false,
 	"type": "module",
 	"author": "so-better",
@@ -17,11 +17,11 @@
 	},
 	"dependencies": {
 		"csstype": "^3.1.3",
-		"dap-util": "^1.5.9",
+		"dap-util": "1.6.0",
 		"highlight.js": "^11.10.0",
 		"interactjs": "^1.10.27",
 		"katex": "^0.16.11",
-		"vue": "^3.5.12"
+		"vue": "^3.3.13"
 	},
 	"devDependencies": {
 		"@types/katex": "^0.16.7",

package/lib/model/config/dom-observe.d.ts

@@ -1,10 +0,0 @@
-import { Editor } from '../Editor';
-/**
- * 移除对编辑器的dom监听
- */
-export declare const removeDomObserve: (editor: Editor) => void;
-/**
- * 设置对编辑器的dom监听，主要解决非法dom插入问题
- * 中文输入和updateView时不会启用dom监听
- */
-export declare const setDomObserve: (editor: Editor) => void;