@kaitify/core 0.0.1-beta.9 → 0.0.2-beta.1

package/README.md

@@ -1,3 +1,3 @@
-#### 基于原生 JS 的富文本编辑器核心库
+##### 基于原生 JS 的富文本编辑器核心库
 
-> 具体使用方法请参阅：[@kaitify/core](https://www.so-better.cn/kaitify-core/)
+> [@kaitify/core 官方文档](https://www.so-better.cn/docs/kaitify-core/)

package/lib/extensions/Extension.d.ts

@@ -22,7 +22,7 @@ export type ExtensionCreateOptionType = {
     /**
      * 自定义dom转为非文本节点的后续处理
      */
-    domParseNodeCallback?: (this: Editor, node: KNode) => KNode;
+    onDomParseNode?: (this: Editor, node: KNode) => KNode;
     /**
      * 光标变化回调
      */
@@ -54,27 +54,27 @@ export type ExtensionCreateOptionType = {
     /**
      * 节点粘贴保留标记的自定义方法
      */
-    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;
     /**
      * 自定义命令
      */
@@ -107,7 +107,7 @@ export declare class Extension {
     /**
      * 自定义dom转为非文本节点的后续处理
      */
-    domParseNodeCallback?: (this: Editor, node: KNode) => KNode;
+    onDomParseNode?: (this: Editor, node: KNode) => KNode;
     /**
      * 光标变化回调
      */
@@ -139,27 +139,27 @@ export declare class Extension {
     /**
      * 节点粘贴保留标记的自定义方法
      */
-    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;
     /**
      * 自定义命令
      */

package/lib/extensions/align/index.d.ts

@@ -2,8 +2,17 @@ import { Extension } from '../Extension';
 export type AlignValueType = 'left' | 'right' | 'center' | 'justify';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在的块节点是否都是符合的对齐方式
+         */
         isAlign?: (value: AlignValueType) => boolean;
+        /**
+         * 设置对齐方式
+         */
         setAlign?: (value: AlignValueType) => Promise<void>;
+        /**
+         * 取消对齐方式
+         */
         unsetAlign?: (value: AlignValueType) => Promise<void>;
     }
 }

package/lib/extensions/attachment/index.d.ts

@@ -15,10 +15,25 @@ export type AttachmentExtensionPropsType = {
 };
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的附件节点，如果光标不在一个附件节点内，返回null
+         */
         getAttachment?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有附件节点
+         */
         hasAttachment?: () => boolean;
+        /**
+         * 插入附件
+         */
         setAttachment?: (options: SetAttachmentOptionType) => Promise<void>;
+        /**
+         * 更新附件
+         */
         updateAttachment?: (options: UpdateAttachmentOptionType) => Promise<void>;
+        /**
+         * 获取附件信息
+         */
         getAttachmentInfo?: () => {
             url: string;
             text: string;

package/lib/extensions/back-color/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本的背景颜色是否与入参一致
+         */
         isBackColor?: (value: string) => boolean;
+        /**
+         * 设置背景颜色
+         */
         setBackColor?: (value: string) => Promise<void>;
+        /**
+         * 取消背景颜色
+         */
         unsetBackColor?: (value: string) => Promise<void>;
     }
 }

package/lib/extensions/blockquote/index.d.ts

@@ -2,10 +2,25 @@ import { KNode } from '../../model';
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的引用节点，如果光标不在一个引用节点内，返回null
+         */
         getBlockquote?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有引用节点
+         */
         hasBlockquote?: () => boolean;
+        /**
+         * 光标范围内是否都是引用节点
+         */
         allBlockquote?: () => boolean;
+        /**
+         * 设置引用
+         */
         setBlockquote?: () => Promise<void>;
+        /**
+         * 取消引用
+         */
         unsetBlockquote?: () => Promise<void>;
     }
 }

package/lib/extensions/bold/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本是否加粗
+         */
         isBold?: () => boolean;
+        /**
+         * 设置加粗
+         */
         setBold?: () => Promise<void>;
+        /**
+         * 取消加粗
+         */
         unsetBold?: () => Promise<void>;
     }
 }

package/lib/extensions/code/index.d.ts

@@ -2,10 +2,25 @@ import { KNode } from '../../model';
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的行内代码，如果光标不在一个行内代码内，返回null
+         */
         getCode?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有行内代码
+         */
         hasCode?: () => boolean;
+        /**
+         * 光标范围内是否都是行内代码
+         */
         allCode?: () => boolean;
+        /**
+         * 设置行内代码
+         */
         setCode?: () => Promise<void>;
+        /**
+         * 取消行内代码
+         */
         unsetCode?: () => Promise<void>;
     }
 }

package/lib/extensions/code-block/index.d.ts

@@ -3,11 +3,29 @@ import { Extension } from '../Extension';
 import { HljsLanguageType } from './hljs';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的代码块节点，如果光标不在一个代码块节点内，返回null
+         */
         getCodeBlock?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有代码块节点
+         */
         hasCodeBlock?: () => boolean;
+        /**
+         * 光标范围内是否都是代码块节点
+         */
         allCodeBlock?: () => boolean;
+        /**
+         * 设置代码块
+         */
         setCodeBlock?: () => Promise<void>;
+        /**
+         * 取消代码块
+         */
         unsetCodeBlock?: () => Promise<void>;
+        /**
+         * 更新光标所在代码块的语言类型
+         */
         updateCodeBlockLanguage?: (language: HljsLanguageType) => Promise<void>;
     }
 }

package/lib/extensions/color/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本的颜色是否与入参一致
+         */
         isColor?: (value: string) => boolean;
+        /**
+         * 设置颜色
+         */
         setColor?: (value: string) => Promise<void>;
+        /**
+         * 取消颜色
+         */
         unsetColor?: (value: string) => Promise<void>;
     }
 }

package/lib/extensions/font-family/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本的字体是否与入参一致
+         */
         isFontFamily?: (value: string) => boolean;
+        /**
+         * 设置字体
+         */
         setFontFamily?: (value: string) => Promise<void>;
+        /**
+         * 取消字体
+         */
         unsetFontFamily?: (value: string) => Promise<void>;
     }
 }

package/lib/extensions/font-size/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本的字号大小是否与入参一致
+         */
         isFontSize?: (value: string) => boolean;
+        /**
+         * 设置字号
+         */
         setFontSize?: (value: string) => Promise<void>;
+        /**
+         * 取消字号
+         */
         unsetFontSize?: (value: string) => Promise<void>;
     }
 }

package/lib/extensions/heading/index.d.ts

@@ -3,10 +3,25 @@ import { Extension } from '../Extension';
 export type HeadingLevelType = 0 | 1 | 2 | 3 | 4 | 5 | 6;
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的标题，如果光标不在一个标题内，返回null
+         */
         getHeading?: (level: HeadingLevelType) => KNode | null;
+        /**
+         * 判断光标范围内是否有标题
+         */
         hasHeading?: (level: HeadingLevelType) => boolean;
+        /**
+         * 光标范围内是否都是标题
+         */
         allHeading?: (level: HeadingLevelType) => boolean;
+        /**
+         * 设置标题
+         */
         setHeading?: (level: HeadingLevelType) => Promise<void>;
+        /**
+         * 取消标题
+         */
         unsetHeading?: (level: HeadingLevelType) => Promise<void>;
     }
 }

package/lib/extensions/history/index.d.ts

@@ -1,9 +1,21 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 是否可以撤销
+         */
         canUndo?: () => boolean;
+        /**
+         * 是否可以重做
+         */
         canRedo?: () => boolean;
+        /**
+         * 撤销
+         */
         undo?: () => Promise<void>;
+        /**
+         * 重做
+         */
         redo?: () => Promise<void>;
     }
 }

package/lib/extensions/horizontal/index.d.ts

@@ -1,6 +1,9 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 设置分隔线
+         */
         setHorizontal?: () => Promise<void>;
     }
 }

package/lib/extensions/image/index.d.ts

@@ -17,9 +17,21 @@ export type UpdateImageOptionType = {
 };
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的图片，如果光标不在一张图片内，返回null
+         */
         getImage?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有图片
+         */
         hasImage?: () => boolean;
+        /**
+         * 插入图片
+         */
         setImage?: (options: SetImageOptionType) => Promise<void>;
+        /**
+         * 更新图片
+         */
         updateImage?: (options: UpdateImageOptionType) => Promise<void>;
     }
 }

package/lib/extensions/indent/index.d.ts

@@ -1,7 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 是否可以使用缩进
+         */
+        canUseIndent?: () => boolean;
+        /**
+         * 增加缩进
+         */
         setIncreaseIndent?: () => Promise<void>;
+        /**
+         * 减少缩进
+         */
         setDecreaseIndent?: () => Promise<void>;
     }
 }

package/lib/extensions/italic/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本是否斜体
+         */
         isItalic?: () => boolean;
+        /**
+         * 设置斜体
+         */
         setItalic?: () => Promise<void>;
+        /**
+         * 取消斜体
+         */
         unsetItalic?: () => Promise<void>;
     }
 }

package/lib/extensions/line-height/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在的块节点是否都是符合的行高
+         */
         isLineHeight?: (value: string | number) => boolean;
+        /**
+         * 设置行高
+         */
         setLineHeight?: (value: string | number) => Promise<void>;
+        /**
+         * 取消行高
+         */
         unsetLineHeight?: (value: string | number) => Promise<void>;
     }
 }

package/lib/extensions/link/index.d.ts

@@ -17,10 +17,25 @@ export type UpdateLinkOptionType = {
 };
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的链接，如果光标不在一个链接内，返回null
+         */
         getLink?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有链接
+         */
         hasLink?: () => boolean;
+        /**
+         * 设置连接
+         */
         setLink?: (options: SetLinkOptionType) => Promise<void>;
+        /**
+         * 更新链接
+         */
         updateLink?: (options: UpdateLinkOptionType) => Promise<void>;
+        /**
+         * 取消链接
+         */
         unsetLink?: () => Promise<void>;
     }
 }

package/lib/extensions/list/index.d.ts

@@ -8,11 +8,37 @@ export type ListOptionsType = {
 };
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的有序列表或者无序列表，如果光标不在一个有序列表或者无序列表内，返回null
+         */
         getList?: (options: ListOptionsType) => KNode | null;
+        /**
+         * 判断光标范围内是否有有序列表或者无序列表
+         */
         hasList?: (options: ListOptionsType) => boolean;
+        /**
+         * 判断光标范围内是否都是有序列表或者无序列表
+         */
         allList?: (options: ListOptionsType) => boolean;
+        /**
+         * 设置有序列表或者无序列表
+         */
         setList?: (options: ListOptionsType) => Promise<void>;
+        /**
+         * 取消有序列表或者无序列表
+         */
         unsetList?: (options: ListOptionsType) => Promise<void>;
+        /**
+         * 是否可以生成内嵌列表
+         */
+        canCreateInnerList?: () => {
+            node: KNode;
+            previousNode: KNode;
+        } | null;
+        /**
+         * 根据当前光标所在的li节点生成一个内嵌列表
+         */
+        createInnerList?: () => Promise<void>;
     }
 }
 export declare const ListExtension: () => Extension;

package/lib/extensions/math/index.d.ts

@@ -2,9 +2,21 @@ import { KNode } from '../../model';
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的数学公式节点，如果光标不在一个数学公式节点内，返回null
+         */
         getMath?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有数学公式节点
+         */
         hasMath?: () => boolean;
+        /**
+         * 插入数学公式
+         */
         setMath?: (value: string) => Promise<void>;
+        /**
+         * 更新数学公式
+         */
         updateMath?: (value: string) => Promise<void>;
     }
 }

package/lib/extensions/strikethrough/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本是否删除线
+         */
         isStrikethrough?: () => boolean;
+        /**
+         * 设置删除线
+         */
         setStrikethrough?: () => Promise<void>;
+        /**
+         * 取消删除线
+         */
         unsetStrikethrough?: () => Promise<void>;
     }
 }

package/lib/extensions/subscript/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本是否下标
+         */
         isSubscript?: () => boolean;
+        /**
+         * 设置下标
+         */
         setSubscript?: () => Promise<void>;
+        /**
+         * 取消下标
+         */
         unsetSubscript?: () => Promise<void>;
     }
 }

package/lib/extensions/superscript/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本是否上标
+         */
         isSuperscript?: () => boolean;
+        /**
+         * 设置上标
+         */
         setSuperscript?: () => Promise<void>;
+        /**
+         * 取消上标
+         */
         unsetSuperscript?: () => Promise<void>;
     }
 }

package/lib/extensions/table/index.d.ts

@@ -3,18 +3,48 @@ import { Extension } from '../Extension';
 export type TableCellsMergeDirectionType = 'left' | 'top' | 'right' | 'bottom';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的表格节点，如果光标不在一个表格节点内，返回null
+         */
         getTable?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有表格节点
+         */
         hasTable?: () => boolean;
+        /**
+         * 是否可以合并单元格
+         */
         canMergeTableCells?: (direction: TableCellsMergeDirectionType) => boolean;
+        /**
+         * 插入表格
+         */
         setTable?: ({ rows, columns }: {
             rows: number;
             columns: number;
         }) => Promise<void>;
+        /**
+         * 取消表格
+         */
         unsetTable?: () => Promise<void>;
+        /**
+         * 合并单元格
+         */
         mergeTableCell?: (direction: TableCellsMergeDirectionType) => Promise<void>;
+        /**
+         * 添加行
+         */
         addTableRow?: (direction: 'top' | 'bottom') => Promise<void>;
+        /**
+         * 删除行
+         */
         deleteTableRow?: () => Promise<void>;
+        /**
+         * 添加列
+         */
         addTableColumn?: (direction: 'left' | 'right') => Promise<void>;
+        /**
+         * 删除列
+         */
         deleteTableColumn?: () => Promise<void>;
     }
 }