@officesdk/editor-sdk-core 0.0.0-12 → 0.0.0-14

package/types/docx.d.ts

@@ -66,19 +66,41 @@ export declare abstract class AbstractedEditorFileUploader {
 }
 
 /**
- * 传统文档工具栏一级菜单
+ * 传统文档右键菜单功能按钮
  */
-export declare type DocxContextMenuEntryConfig = EditorContextMenuEntryConfig<DocxContextMenuFeatureButtonName>;
-
+export declare type DocxContextMenuFeatureButtonName = 
 /**
- * 传统文档工具栏功能按钮
- */
-export declare type DocxContextMenuFeatureButtonConfig = EditorContextMenuFeatureButtonConfig<DocxContextMenuFeatureButtonName>;
-
+* 剪切
+*/
+'cut'
 /**
- * 传统文档右键菜单功能按钮
- */
-export declare type DocxContextMenuFeatureButtonName = 'cut' | 'copy' | 'paste' | 'delete' | 'font' | 'paragraph' | 'downloadAttachment' | 'transformPDF';
+* 复制
+*/
+| 'copy'
+/**
+* 粘贴
+*/
+| 'paste'
+/**
+* 删除
+*/
+| 'delete'
+/**
+* 字体
+*/
+| 'font'
+/**
+* 段落
+*/
+| 'paragraph'
+/**
+* 下载附件
+*/
+| 'downloadAttachment'
+/**
+* 转换PDF
+*/
+| 'transformPDF';
 
 export declare type DocxContextMenuOptions = EditorContextMenuOptions<DocxContextMenuFeatureButtonName>;
 
@@ -187,20 +209,18 @@ export declare interface DocxInfoOptions {
 }
 
 /**
- * 传统文档工具栏一级菜单
+ * 传统文档菜单栏一级菜单
  */
 export declare type DocxMenuEntryConfig = EditorMenuEntryConfig<DocxMenuFeatureButtonName>;
 
 /**
- * 传统文档工具栏功能按钮
+ * 传统文档菜单栏内置功能按钮
  */
-export declare type DocxMenuFeatureButtonConfig = EditorMenuFeatureButtonConfig<DocxMenuFeatureButtonName>;
+export declare type DocxMenuFeatureButtonName = 'file' | 'edit' | 'insert' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'insertAttachment' | 'insertCloudFile' | 'insertSignature' | 'insertImageFromUrl';
 
 /**
- * 传统文档工具栏内置功能按钮
+ * 传统文档菜单栏相关配置，目前菜单栏不是所有套件都支持，
  */
-export declare type DocxMenuFeatureButtonName = 'file' | 'edit' | 'insert' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'export' | 'saveTemplate' | 'viewHistory' | 'saveHistory' | 'exportImage' | 'exportPDF' | 'exportWPS' | 'exportImagePDF' | 'insertAttachment' | 'insertCloudFile' | 'insertSignature' | 'insertImageFromUrl';
-
 export declare type DocxMenuOptions = EditorMenuOptions<DocxMenuFeatureButtonName>;
 
 /**
@@ -1319,27 +1339,6 @@ export declare interface EditorContent<Delta = EditorDelta> {
     addChangeListener: (listener: (change: Delta) => void) => () => void;
 }
 
-/**
- * 右键菜单栏二级以下的菜单入口
- */
-export declare type EditorContextMenuEntryButton<TName extends string> = EditorMenuEntryButton<TName>;
-
-/**
- * 右键菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
- * 右键菜单栏一级菜单指点击右键弹出菜单时的菜单项
- */
-export declare type EditorContextMenuEntryConfig<TName extends string> = EditorMenuEntryConfig<TName>;
-
-/**
- * 右键菜单栏功能按钮配置
- */
-export declare type EditorContextMenuFeatureButton<TName extends string> = EditorMenuFeatureButton<TName>;
-
-/**
- * 右键菜单栏按钮配置
- */
-export declare type EditorContextMenuFeatureButtonConfig<TName extends string> = EditorMenuFeatureButtonConfig<TName>;
-
 /**
  * 右键菜单栏相关配置
  * 右键菜单栏是指的编辑器中点击右键弹出的菜单栏。目前等于菜单栏配置，可扩展
@@ -1533,120 +1532,137 @@ export declare interface EditorLocalUploadableFile extends EditorBaseUploadableF
 }
 
 /**
- * 菜单栏自定义按钮配置
+ * 基础菜单项配置，所有菜单项类型都包含这些属性
  */
-export declare type EditorMenuCustomButton = {
-    /**
-     * 按钮名称
-     */
-    name: string;
-    /**
-     * 链接
-     */
-    type: 'link';
+export declare interface EditorMenuBaseMenuItemConfig<TName extends string> {
     /**
-     * 按钮文本
+     * 菜单项的唯一标识，用以确定配置的是哪个菜单
      */
-    text: string;
-    /**
-     * 链接地址
-     */
-    url: string;
-} | {
+    name: TName;
     /**
-     * 按钮名称
+     * 菜单项类型
      */
-    name: string;
+    type: EditorMenuItemType;
+}
+
+/**
+ * 按钮菜单项配置
+ */
+export declare interface EditorMenuButtonMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'button';
     /**
-     * 按钮，点击后触发 callback 回调
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    type: 'button';
+    disabled?: boolean;
     /**
-     * 按钮文本
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
      */
-    label: string;
+    label?: string;
     /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
     icon?: string;
     /**
-     * 按钮点击事件
+     * 菜单项点击事件，接受一个函数，可以自定义点击事件
      */
-    callback: () => void;
-};
+    callback?: () => void;
+}
 
 /**
- * 菜单栏二级以下的菜单入口
+ * 编辑器菜单配置类型
+ * 联合类型，表示可以是任意一种菜单项配置
  */
-export declare interface EditorMenuEntryButton<TName extends string> {
+export declare type EditorMenuEntryConfig<TName extends string> = EditorMenuHiddenMenuItemConfig<TName> | EditorMenuButtonMenuItemConfig<TName> | EditorMenuLinkMenuItemConfig<TName> | EditorMenuEntryMenuItemConfig<TName>;
+
+/**
+ * 子菜单入口配置
+ */
+export declare interface EditorMenuEntryMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
     type: 'entry';
     /**
-     * 菜单名称
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    name: string;
+    disabled?: boolean;
     /**
-     * 菜单图标
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
+     */
+    label?: string;
+    /**
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
     icon?: string;
     /**
-     * 下一级子菜单
+     * 下一级菜单配置，下一级菜单配置项和上一级相同
+     * 如果下一级仍然是 entry 类型，可以无限向下扩展
      */
-    children?: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
+    children?: EditorMenuEntryConfig<TName>[];
 }
 
 /**
- * 菜单栏一级菜单配置，此处用于定义一级菜单的操作入口，
- * 一级菜单在鼠标悬停时展示二级列表
+ * 菜单功能按钮配置
  */
-export declare interface EditorMenuEntryConfig<TName extends string> {
+export declare interface EditorMenuFeatureConfig {
     /**
-     * 一级菜单名称
+     * 是否隐藏菜单项，设置为true则隐藏菜单项
      */
-    name: string;
-    /**
-     * 二级菜单定义，定一个二维数组，用于定义二级菜单的结构，
-     * 将第一层数组中的所有按钮放到一个区域内用分隔符隔开，
-     * 第二层数组为按钮的定义，可以是功能按钮也可以是一个下拉入口。
-     */
-    children: Array<EditorMenuFeatureButton<TName> | EditorMenuEntryButton<TName>>[];
+    hidden?: boolean;
     /**
-     * 是否隐藏一级菜单
+     * 是否禁用菜单项，设置为true则变为灰色不可点击
      */
-    type?: 'hidden';
+    disabled?: boolean;
 }
 
 /**
- * 菜单栏功能按钮配置
+ * 菜单功能按钮配置
  */
-export declare type EditorMenuFeatureButton<TName extends string> = {
+export declare interface EditorMenuFeatureConfig {
     /**
-     * 隐藏按钮，用作在需要隐藏菜单栏时定义
+     * 是否隐藏菜单项，设置为true则隐藏菜单项
      */
-    type: 'hidden';
+    hidden?: boolean;
     /**
-     * 按钮名称
+     * 是否禁用菜单项，设置为true则变为灰色不可点击
      */
-    name: TName;
-} | {
-    type: 'button';
+    disabled?: boolean;
+}
+
+/**
+ * 隐藏菜单项配置
+ */
+export declare interface EditorMenuHiddenMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'hidden';
+}
+
+/**
+ * 菜单项类型
+ */
+export declare type EditorMenuItemType = 'hidden' | 'button' | 'link' | 'entry';
+
+/**
+ * 链接菜单项配置
+ */
+export declare interface EditorMenuLinkMenuItemConfig<TName extends string> extends EditorMenuBaseMenuItemConfig<TName> {
+    type: 'link';
     /**
-     * 按钮名称
+     * 是否禁用菜单项，禁用后菜单项依旧显示不过变为灰色，不可点击
      */
-    name: TName;
+    disabled?: boolean;
     /**
-     * 按钮标签（显示文本）
+     * 菜单项显示文本，修改该值可以替换此菜单项默认显示文案
      */
-    label: string;
+    text?: string;
     /**
-     * 按钮图标，可以是 base64 的图片信息，也可以是图片 url
+     * 菜单项图标，可以是 base64 的图片信息，也可以是图片 url
+     * 配置为空字符串则可以隐藏菜单项默认的图标
      */
     icon?: string;
-};
-
-/**
- * 菜单栏按钮配置
- */
-export declare type EditorMenuFeatureButtonConfig<TName extends string> = Record<TName, EditorMenuFeatureButton<TName>>;
+    /**
+     * 跳转链接地址
+     */
+    url?: string;
+}
 
 /**
  * 菜单栏相关配置，目前菜单栏不是所有套件都支持，
@@ -1654,25 +1670,26 @@ export declare type EditorMenuFeatureButtonConfig<TName extends string> = Record
  */
 export declare interface EditorMenuOptions<TName extends string> {
     /**
-     * 菜单栏是否隐藏
+     * 菜单栏是否隐藏，设置为true, 则整个菜单栏不显示
      */
     hidden?: boolean;
     /**
-     * 是否禁用菜单栏所有功能
+     * 是否禁用菜单栏所有功能。设置为true，菜单栏依旧显示，但所有菜单项为灰色不可点击
      */
     disabled?: boolean;
     /**
-     * 菜单栏一级菜单配置
+     * 菜单栏一级菜单配置，指显示在菜单栏上的菜单项。
      */
     entries?: EditorMenuEntryConfig<TName>[];
     /**
      * 菜单栏功能按钮配置
+     * TODO 此配置目前没有用到，后续看是保留还是和custom合并
      */
-    features?: Partial<EditorMenuFeatureButtonConfig<TName>>;
+    features?: Record<TName, EditorMenuFeatureConfig>;
     /**
      * 自定义按钮配置
      */
-    custom?: EditorMenuCustomButton[];
+    custom?: (EditorMenuButtonMenuItemConfig<string> | EditorMenuLinkMenuItemConfig<string>)[];
 }
 
 /**
@@ -2035,43 +2052,15 @@ export declare interface EditorTextOptions<Color = string> {
 }
 
 /**
- * 工具栏自定义按钮配置
- */
-export declare interface EditorToolbarCustomButton extends Omit<EditorToolbarFeatureButton, 'name'> {
-    /**
-     * 自定义按钮名称
-     */
-    name: string;
-    /**
-     * 按钮点击事件
-     */
-    callback: () => void;
-    /**
-     * 按钮在工具栏中的位置，默认添加到工具栏所有按钮后面
-     */
-    index?: number;
-}
-
-/**
- * 工具栏自定义按钮配置
- */
-export declare interface EditorToolbarCustomButtonConfig {
-    /**
-     * 按钮配置
-     */
-    [key: string]: EditorToolbarCustomButton;
-}
-
-/**
- * 工具栏内置功能按钮配置
+ * 工具栏功能按钮配置(包括内置按钮和自定义按钮)
  */
-export declare interface EditorToolbarFeatureButton<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
+export declare interface EditorToolbarFeatureButton<TName extends string> {
     /**
-     * 按钮类型
+     * 按钮的唯一标识，用以确定配置的是哪个按钮。
      */
-    name: ToolButtonName;
+    name: TName;
     /**
-     * 按钮标签（显示文本）
+     * 按钮标签（显示文本）一般工具栏上的按钮不会显示文本，如果需要显示文本，配置此项。
      */
     label?: string;
     /**
@@ -2079,63 +2068,38 @@ export declare interface EditorToolbarFeatureButton<ToolButtonName extends strin
      */
     icon?: string;
     /**
-     * 按钮是否隐藏
+     * 按钮是否隐藏，设置为true则隐藏按钮
      */
     hidden?: boolean;
     /**
-     * 按钮是否禁用
+     * 按钮是否禁用，设置为true则变为灰色不可点击
      */
     disabled?: boolean;
     /**
-     * 按钮提示文本
+     * 按钮点击事件.接受一个函数，可以自定义点击事件。
+     */
+    callback?: () => void;
+    /**
+     * 按钮提示文本,鼠标悬浮到按钮上时显示的tooltip文字
      */
     tooltip?: string;
+    /**
+     * 按钮在工具栏中位置，不设置则按照默认位置
+     */
+    index?: number;
 }
 
 /**
  * 工具栏内置功能按钮配置
  */
-export declare type EditorToolbarFeatureButtonConfig<ToolButtonName extends string> = {
-    [key in ToolButtonName]?: EditorToolbarFeatureButton<ToolButtonName>;
+export declare type EditorToolbarFeatureButtonConfig<TName extends string> = {
+    [key in TName]?: EditorToolbarFeatureButton<key>;
 };
 
-/**
- * 工具栏内置功能按钮
- */
-export declare type EditorToolbarFeatureButtonName = 
-/**
-* 加粗
-*/
-'bold'
-/**
-* 斜体
-*/
-| 'italic'
-/**
-* 下划线
-*/
-| 'underline'
-/**
-* 删除线
-*/
-| 'strikethrough'
-/**
-* 插入图片
-*/
-| 'insertImage'
-/**
-* 插入链接
-*/
-| 'insertLink'
-/**
-* 限制编辑
-*/
-| 'restriction';
-
 /**
  * 工具栏相关设置，可以控制工具栏的显示内容
  */
-export declare interface EditorToolbarOptions<ToolButtonName extends string = EditorToolbarFeatureButtonName> {
+export declare interface EditorToolbarOptions<TName extends string> {
     /**
      * 控制工具栏显隐状态
      */
@@ -2147,11 +2111,11 @@ export declare interface EditorToolbarOptions<ToolButtonName extends string = Ed
     /**
      * 现有按钮的功能配置
      */
-    features?: EditorToolbarFeatureButtonConfig<ToolButtonName>;
+    features?: EditorToolbarFeatureButtonConfig<TName>;
     /**
      * 自定义按钮
      */
-    custom?: EditorToolbarCustomButtonConfig;
+    custom?: EditorToolbarFeatureButtonConfig<string>;
 }
 
 export declare type EditorUploadableFile = EditorLocalUploadableFile;