@kaitify/core 0.0.1-beta.2 → 0.0.1-beta.21

package/lib/model/Editor.d.ts

@@ -377,6 +377,10 @@ export declare class Editor {
      * 是否深色模式
      */
     isDark(): boolean;
+    /**
+     * 判断编辑器是否为空，这里的空指的是编辑器内只有一个段落，并且段落里只有占位符
+     */
+    isEmpty(): boolean;
     /**
      * dom转KNode
      */
@@ -408,11 +412,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 +440,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 +470,12 @@ export declare class Editor {
      */
     insertText(text: string): void;
     /**
-     * 向选区进行换行，如果所在块节点只有占位符并且块节点不是段落则会转为段落
+     * 向选区进行换行
+     * 1. 所在块节点只有占位符并且块节点不是段落则会转为段落
+     * 2. 非代码块样式内换行是插入换行符\n
+     * 2. 光标所在块节点是固定块节点，则无法换行
+     * 3. 光标所在块节点只有占位符，并且其存在父节点，且父节点不是固定块节点，会从父节点抽离到与父节点同级
+     * 4. 光标所在块节点只有占位符，并且不存在父节点，且不是段落，则会转为段落
      */
     insertParagraph(): void;
     /**
@@ -496,7 +505,11 @@ export declare class Editor {
     /**
      * 获取编辑器的纯文本内容
      */
-    getText(): string;
+    getContent(): string;
+    /**
+     * 获取编辑器的html内容，该方法会返回一个包含style标签和div标签的html内容。自行展示html内容时可保证样式与编辑器一致，但是对于附件等有交互事件的元素交互事件会失效
+     */
+    getHTML(): string;
     /**
      * 配置编辑器，返回创建的编辑器
      */

package/lib/model/KNode.d.ts

@@ -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[];
     /**

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

@@ -12,7 +12,9 @@ export type RuleFunctionType = (state: {
  */
 export declare const fomratBlockTagParse: RuleFunctionType;
 /**
- * 针对子节点中的块节点：行内节点的子节点中含有块节点则该节点转为块节点；子节点中的其他节点也转为块节点
+ * 针对子节点中的块节点：
+ * 1. 子节点中含有块节点则该节点转为块节点；
+ * 2. 子节点中含有块节点，则其他节点也转为块节点
  */
 export declare const formatBlockInChildren: RuleFunctionType;
 /**
@@ -27,6 +29,10 @@ export declare const formatPlaceholderMerge: RuleFunctionType;
  * 针对节点自身：将文本节点内连续的零宽度无断空白字符合并（光标可能会更新）
  */
 export declare const formatZeroWidthTextMerge: RuleFunctionType;
+/**
+ * 针对节点自身：统一将文本节点内的\r\n换成\n，解决Windows兼容问题
+ */
+export declare const formatLineBreakText: 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

@@ -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,52 +1,52 @@
 {
-  "name": "@kaitify/core",
-  "version": "0.0.1-beta.2",
-  "private": false,
-  "type": "module",
-  "author": "so-better",
-  "main": "lib/kaitify-core.umd.js",
-  "module": "lib/kaitify-core.es.js",
-  "types": "lib/index.d.ts",
-  "license": "MIT",
-  "description": "基于原生JS的富文本编辑器核心库",
-  "scripts": {
-    "dev": "vite",
-    "lib": "tsc && vite build",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs"
-  },
-  "dependencies": {
-    "csstype": "^3.1.3",
-    "dap-util": "^1.5.8",
-    "highlight.js": "^11.10.0",
-    "interactjs": "^1.10.27",
-    "katex": "^0.16.11",
-    "vue": "^3.5.12"
-  },
-  "devDependencies": {
-    "@types/katex": "^0.16.7",
-    "@types/node": "^20.11.24",
-    "@vitejs/plugin-vue": "^5.0.4",
-    "less": "^3.0.4",
-    "less-loader": "^5.0.0",
-    "terser": "^5.16.9",
-    "typescript": "^5.6.3",
-    "vite": "^5.4.10",
-    "vite-plugin-css-injected-by-js": "^3.5.1",
-    "vite-plugin-dts": "^4.3.0",
-    "vitepress": "^1.5.0"
-  },
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not dead"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/so-better/kaitify-core"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  }
+	"name": "@kaitify/core",
+	"version": "0.0.1-beta.21",
+	"private": false,
+	"type": "module",
+	"author": "so-better",
+	"main": "lib/kaitify-core.umd.js",
+	"module": "lib/kaitify-core.es.js",
+	"types": "lib/index.d.ts",
+	"license": "MIT",
+	"description": "基于原生JS的富文本编辑器核心库",
+	"scripts": {
+		"dev": "vite",
+		"lib": "tsc && vite build",
+		"docs:dev": "vitepress dev docs",
+		"docs:build": "vitepress build docs"
+	},
+	"dependencies": {
+		"csstype": "^3.1.3",
+		"dap-util": "1.6.0",
+		"highlight.js": "^11.10.0",
+		"interactjs": "^1.10.27",
+		"katex": "^0.16.11",
+		"vue": "^3.3.13"
+	},
+	"devDependencies": {
+		"@types/katex": "^0.16.7",
+		"@types/node": "^20.11.24",
+		"@vitejs/plugin-vue": "^5.0.4",
+		"less": "^3.0.4",
+		"less-loader": "^5.0.0",
+		"terser": "^5.16.9",
+		"typescript": "^5.6.3",
+		"vite": "^5.4.10",
+		"vite-plugin-css-injected-by-js": "^3.5.1",
+		"vite-plugin-dts": "^4.3.0",
+		"vitepress": "^1.5.0"
+	},
+	"browserslist": [
+		"> 1%",
+		"last 2 versions",
+		"not dead"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/so-better/kaitify-core"
+	},
+	"publishConfig": {
+		"access": "public",
+		"registry": "https://registry.npmjs.org"
+	}
 }