vue-editify 0.2.13 → 0.2.15

package/lib/core/function.d.ts

@@ -1,4 +1,4 @@
-import { AlexElement, AlexElementsRangeType, AlexEditor } from 'alex-editor';
+import { AlexEditor, AlexElement, AlexElementsRangeType } from 'alex-editor';
 import { ObjectType } from './tool';
 
 export type ElementMatchConfigType = {
@@ -63,110 +63,187 @@ export declare const getMatchElementByElement: (element: AlexElement, config: El
  */
 export declare const getMatchElementByRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, config: ElementMatchConfigType) => AlexElement | null;
 /**
- * Open API：判断元素是否有序或者无序列表
+ * Open API：判断元素是否有序或者无序列表，不做空元素判断
  * @param element
  * @param ordered
  * @returns
  */
-export declare const isList: (element: AlexElement, ordered?: boolean | undefined) => boolean;
+export declare const elementIsList: (element: AlexElement, ordered?: boolean | undefined) => boolean;
 /**
- * Open API：判断元素是否任务列表
+ * Open API：判断元素是否在有序列表或者无序列表下，是的话返回有序列表或者无序列表元素，否则返回null
  * @param element
+ * @param ordered
  * @returns
  */
-export declare const isTask: (element: AlexElement) => boolean;
+export declare const getListByElement: (element: AlexElement, ordered: boolean) => AlexElement | null;
 /**
- * Open API：判断元素是否在有序列表或者无序列表下
- * @param element
+ * Open API：选区是否含有有序列表或者无序列表，不一定是同一个有序列表或者序列表，只要含有有序列表或者序列表即返回true
+ * @param editor
+ * @param dataRangeCaches
+ * @param ordered
+ * @returns
+ */
+export declare const hasListInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, ordered?: boolean | undefined) => boolean;
+/**
+ * Open API：选区是否全部在有序列表或者无序列表内，不一定是同一个有序列表或者无序列表
+ * @param editor
+ * @param dataRangeCaches
  * @param ordered
  * @returns
  */
-export declare const elementIsInList: (element: AlexElement, ordered: boolean) => boolean;
+export declare const rangeIsInList: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, ordered?: boolean | undefined) => boolean;
 /**
- * Open API：判断元素是否在任务列表下
+ * Open API：判断元素是否任务列表，不做空元素判断
  * @param element
  * @returns
  */
-export declare const elementIsInTask: (element: AlexElement) => boolean;
+export declare const elementIsTask: (element: AlexElement) => boolean;
 /**
- * Open API：选区是否含有代码块
+ * Open API：判断元素是否在任务列表下，是的话返回任务列表元素，否则返回null
+ * @param element
+ * @returns
+ */
+export declare const getTaskByElement: (element: AlexElement) => AlexElement | null;
+/**
+ * Open API：选区是否含有任务列表，不一定是同一个任务列表，只要含有任务列表即返回true
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const hasPreInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const hasTaskInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
- * Open API：选区是否含有引用
+ * Open API：选区是否全部在任务列表里，不一定是同一个任务列表
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const hasQuoteInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const rangeIsInTask: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
- * Open API：选区是否含有有序列表或者无序列表
+ * Open API：判断元素是否附件，不做空元素判断
+ * @param element
+ * @returns
+ */
+export declare const elementIsAttachment: (element: AlexElement) => boolean;
+/**
+ * Open API：选区是否含有附件，不一定是同一个附件，只要含有附件即返回true
  * @param editor
  * @param dataRangeCaches
- * @param ordered
  * @returns
  */
-export declare const hasListInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, ordered?: boolean | undefined) => boolean;
+export declare const hasAttachmentInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+/**
+ * Open API：判断元素是否数学公式，不做空元素判断
+ * @param element
+ * @returns
+ */
+export declare const elementIsMathformula: (element: AlexElement) => boolean;
+/**
+ * Open API：判断元素是否在数学公式下，是的话返回数学公式元素，否则返回null
+ * @param element
+ * @returns
+ */
+export declare const getMathformulaByElement: (element: AlexElement) => AlexElement | null;
 /**
- * Open API：选区是否含有任务列表
+ * Open API：选区是否含有数学公式，不一定是同一个数学公式，只要含有数学公式即返回true
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const hasTaskInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const hasMathformulaInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+/**
+ * Open API：判断元素是否面板，不做空元素判断
+ * @param el
+ * @returns
+ */
+export declare const elementIsPanel: (element: AlexElement) => boolean;
 /**
- * Open API：选区是否含有链接
+ * Open API：判断元素是否在面板内，是的话返回面板元素，否则返回null
+ * @param el
+ * @returns
+ */
+export declare const getPanelByElement: (element: AlexElement) => AlexElement | null;
+/**
+ * Open API：选区是否含有面板，不一定是同一个面板，只要含有面板即返回true
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const hasLinkInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const hasPanelInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+/**
+ * Open API：判断元素是否信息块，不做空元素判断
+ * @param el
+ * @returns
+ */
+export declare const elementIsInfoBlock: (element: AlexElement) => boolean;
+/**
+ * Open API：判断元素是否在信息块内，是的话返回信息块元素，否则返回null
+ * @param el
+ * @returns
+ */
+export declare const getInfoBlockByElement: (element: AlexElement) => AlexElement | null;
 /**
- * Open API：选区是否含有表格
+ * Open API：选区是否含有信息块，不一定是同一个信息块，只要含有信息块即返回true
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const hasTableInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const hasInfoBlockInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
- * Open API：选区是否含有图片
+ * Open API：选区是否全部在信息块里，不一定是同一个信息块
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const hasImageInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const rangeIsInInfoBlock: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
- * Open API：选区是否含有视频
+ * Open API：选区是否含有代码块，不一定是同一个代码块，只要含有代码块即返回true
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const hasVideoInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const hasPreInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
- * Open API：选区是否全部在引用内
+ * Open API：选区是否含有引用，不一定是同一个引用，只要含有引用即返回true
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const isRangeInQuote: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const hasQuoteInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
- * Open API：选区是否全部在有序列表或者无序列表内
+ * Open API：选区是否含有链接，不一定是同一个链接，只要含有链接即返回true
  * @param editor
  * @param dataRangeCaches
- * @param ordered
  * @returns
  */
-export declare const isRangeInList: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, ordered?: boolean | undefined) => boolean;
+export declare const hasLinkInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+/**
+ * Open API：选区是否含有表格，不一定是同一个表格，只要含有表格即返回true
+ * @param editor
+ * @param dataRangeCaches
+ * @returns
+ */
+export declare const hasTableInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+/**
+ * Open API：选区是否含有图片，不一定是同一个图片，只要含有图片即返回true
+ * @param editor
+ * @param dataRangeCaches
+ * @returns
+ */
+export declare const hasImageInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+/**
+ * Open API：选区是否含有视频，不一定是同一个视频，只要含有视频即返回true
+ * @param editor
+ * @param dataRangeCaches
+ * @returns
+ */
+export declare const hasVideoInRange: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
- * Open API：选区是否全部在任务列表里
+ * Open API：选区是否全部在引用内，不一定是同一个引用
  * @param editor
  * @param dataRangeCaches
  * @returns
  */
-export declare const isRangeInTask: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
+export declare const rangeIsInQuote: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType) => boolean;
 /**
  * Open API：查询光标所在的文本元素是否具有某个样式
  * @param editor
@@ -186,7 +263,7 @@ export declare const queryTextStyle: (editor: AlexEditor, dataRangeCaches: AlexE
  */
 export declare const queryTextMark: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, name: string, value?: string | number) => boolean;
 /**
- * Open API：获取选区内的文字内容，用于预置链接文字
+ * Open API：获取选区内的文字内容
  * @param dataRangeCaches
  * @returns
  */
@@ -253,7 +330,7 @@ export declare const setQuote: (editor: AlexEditor, dataRangeCaches: AlexElement
  * @param value 取值justify/left/right/center
  * @returns
  */
-export declare const setAlign: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, value: 'justify' | 'left' | 'right' | 'center') => void;
+export declare const setAlign: (editor: AlexEditor, dataRangeCaches: AlexElementsRangeType, value: "justify" | "left" | "right" | "center") => void;
 /**
  * Open API：插入或者取消 有序或者无序列表
  * @param editor

package/lib/core/rule.d.ts

@@ -45,6 +45,26 @@ export declare const tableRangeMergedHandle: (editor: AlexEditor, element: AlexE
  * @param languages
  */
 export declare const preHandle: (editor: AlexEditor, element: AlexElement, highlight: boolean, languages: (string | LanguagesItemType)[]) => void;
+/**
+ * 元素格式化时处理附件元素
+ * @param editor
+ * @param element
+ * @param $editTrans
+ */
+export declare const attachmentHandle: (editor: AlexEditor, element: AlexElement, $editTrans: (key: string) => any) => void;
+/**
+ * 元素格式化时处理数学公式元素
+ * @param editor
+ * @param element
+ */
+export declare const mathformulaHandle: (editor: AlexEditor, element: AlexElement) => void;
+/**
+ * 元素格式化时处理信息块元素
+ * @param editor
+ * @param element
+ * @param color
+ */
+export declare const infoBlockHandle: (_editor: AlexEditor, element: AlexElement, color: string) => void;
 /**
  * 元素格式化时处理一些特殊的内部块元素，转为根级块元素
  * @param editor

package/lib/core/tool.d.ts

@@ -1,9 +1,8 @@
-import { App, Component, ComponentInternalInstance, VNode } from 'vue';
-import { AlexElement } from 'alex-editor';
-import { ButtonOptionsItemType, ButtonTypeType } from '../components/button/props';
+import { App, Component, VNode } from 'vue';
 import { LocaleType } from '../locale';
-import { InsertImageUploadErrorType } from '../components/insertImage/props';
-import { default as Button } from '../components/button/button.vue';
+import { Button, ButtonOptionsItemType, ButtonTypeType } from '../components/button';
+import { InsertImageUploadErrorType } from '../components/insertImage';
+import { InsertAttachmentUploadErrorType } from '../components/insertAttachment';
 
 export type ObjectType = {
     [key: string]: any;
@@ -22,6 +21,7 @@ export interface MenuButtonType {
     show?: boolean;
     leftBorder?: boolean;
     rightBorder?: boolean;
+    disabled?: boolean;
 }
 export interface MenuSelectButtonType extends MenuButtonType {
     options?: (string | number | ButtonOptionsItemType)[];
@@ -34,23 +34,35 @@ export interface MenuDisplayButtonType extends MenuSelectButtonType {
 export interface MenuImageButtonType extends MenuButtonType {
     allowedFileType?: string[];
     multiple?: boolean;
-    maxSize?: number | null;
-    minSize?: number | null;
-    customUpload?: ((files: File[]) => string[]) | ((files: File[]) => Promise<string[]>) | null;
-    handleError?: ((error: InsertImageUploadErrorType, file: File) => void) | null;
+    maxSize?: number;
+    minSize?: number;
+    customUpload?: ((files: File[]) => string[]) | ((files: File[]) => Promise<string[]>);
+    handleError?: (error: InsertImageUploadErrorType, file: File) => void;
 }
 export interface MenuVideoButtonType extends MenuButtonType {
     allowedFileType?: string[];
     multiple?: boolean;
-    maxSize?: number | null;
-    minSize?: number | null;
-    customUpload?: ((files: File[]) => string[]) | ((files: File[]) => Promise<string[]>) | null;
-    handleError?: ((error: InsertImageUploadErrorType, file: File) => void) | null;
+    maxSize?: number;
+    minSize?: number;
+    customUpload?: ((files: File[]) => string[]) | ((files: File[]) => Promise<string[]>);
+    handleError?: (error: InsertImageUploadErrorType, file: File) => void;
 }
 export interface MenuTableButtonType extends MenuButtonType {
     maxRows?: number;
     maxColumns?: number;
 }
+export interface MenuAttachmentButtonType extends MenuButtonType {
+    accept?: string;
+    allowedFileType?: string[];
+    multiple?: boolean;
+    maxSize?: number;
+    minSize?: number;
+    customUpload?: ((files: File[]) => string[]) | ((files: File[]) => Promise<string[]>);
+    handleError?: (error: InsertAttachmentUploadErrorType, file: File) => void;
+}
+export interface MenuMathformulaButtonType extends MenuButtonType {
+    handleError?: (error: Error) => void;
+}
 export type MenuCustomButtonType = {
     type?: ButtonTypeType;
     title?: string;
@@ -96,11 +108,10 @@ export type TextToolbarType = {
 };
 export type ToolbarConfigType = {
     use?: boolean;
-    style?: ObjectType | null;
+    style?: ObjectType;
     tooltip?: boolean;
     codeBlock?: CodeBlockToolbarType;
     text?: TextToolbarType;
-    extraDisabled?: ((name: string) => boolean) | null;
 };
 export type MenuSequenceType = {
     [key: string]: number | undefined;
@@ -133,6 +144,10 @@ export type MenuSequenceType = {
     codeBlock?: number;
     sourceView?: number;
     fullScreen?: number;
+    attachment?: number;
+    mathformula?: number;
+    panel?: number;
+    infoBlock?: number;
 };
 export type MenuModeType = 'default' | 'inner' | 'fixed';
 export type MenuExtendType = {
@@ -142,8 +157,7 @@ export type MenuConfigType = {
     use?: boolean;
     tooltip?: boolean;
     mode?: MenuModeType;
-    extraDisabled?: ((name: string) => boolean) | null;
-    style?: ObjectType | null;
+    style?: ObjectType;
     sequence?: MenuSequenceType;
     undo?: MenuButtonType;
     redo?: MenuButtonType;
@@ -175,24 +189,12 @@ export type MenuConfigType = {
     codeBlock?: MenuButtonType;
     sourceView?: MenuButtonType;
     fullScreen?: MenuButtonType;
+    attachment?: MenuAttachmentButtonType;
+    mathformula?: MenuMathformulaButtonType;
+    panel?: MenuButtonType;
+    infoBlock?: MenuButtonType;
     extends?: MenuExtendType;
 };
-export type PluginMenuConfigType = {
-    extraDisabled?: ((name: string) => boolean) | null;
-    sequence: number;
-    extend: MenuCustomButtonType;
-};
-export type PluginResultType = {
-    name: string;
-    menu?: PluginMenuConfigType;
-    updateView?: () => void;
-    customParseNode?: (element: AlexElement) => AlexElement;
-    extraKeepTags?: string[];
-    renderRule?: (el: AlexElement) => void;
-    pasteKeepMarks?: (el: AlexElement) => ObjectType;
-    pasteKeepStyles?: (el: AlexElement) => ObjectType;
-};
-export type PluginType = (editifyInstance: ComponentInternalInstance, editTrans: (key: string) => any) => PluginResultType;
 export type SFCWithInstall<T> = T & {
     install(app: App): void;
 };
@@ -242,7 +244,7 @@ export declare const getMenuConfig: (editTrans: (key: string) => any, editLocale
  * @param component
  * @returns
  */
-export declare const withInstall: <T extends Component>(component: T) => SFCWithInstall<T>;
+export declare const withInstall: <T extends Component>(component: T) => SFCWithInstall<typeof component>;
 /**
  * 是否点击了编辑器以外的元素
  * @param editor