@juzhenfe/page-model 3.14.9 → 3.14.11

package/dist/components/table/type.d.ts

@@ -1,23 +1,26 @@
 /// <reference path="../../types/common.d.ts" />
 
-import { PaginationProps } from "element-plus";
-import { Sort } from "element-plus/es/components/table/src/table/defaults";
+import { PaginationProps } from 'element-plus'
+import { Sort } from 'element-plus/es/components/table/src/table/defaults'
 import TableManagerDefault from './constructor'
-import { Component } from "vue";
-import { type FilterItemTypeEnum, type FilterMatchModeEnum} from "./components/table-column/components/filter-zone/utils";
+import { Component } from 'vue'
+import {
+  type FilterItemTypeEnum,
+  type FilterMatchModeEnum,
+} from './components/table-column/components/filter-zone/utils'
 
 declare global {
   namespace PageModel {
     type TableManager = TableManagerDefault
 
     type Pagination = {
-      show?: boolean;
-    } & Partial<PaginationProps>;
+      show?: boolean
+    } & Partial<PaginationProps>
 
     type TableDataExportModel = {
-      data: any[];
-      columns: any[];
-      filename: string;
+      data: any[]
+      columns: any[]
+      filename: string
     }
 
     /**
@@ -27,180 +30,212 @@ declare global {
       /**
        * 列的属性
        */
-      prop: string;
+      prop: string
       /**
        * 过滤类型
        */
-      filterType?: FilterItemTypeEnum;
+      filterType?: FilterItemTypeEnum
       /**
        * 筛选条件文本
        */
-      filterLabel?: string;
+      filterLabel?: string
       /**
        * 筛选项
        */
-      filterOptions?: Array<{ label: string; value: string | boolean | number }>;
+      filterOptions?: Array<{ label: string; value: string | boolean | number }>
       /**
        * 当前条件
        */
-      condition?: FilterMatchModeEnum;
+      condition?: FilterMatchModeEnum
       /**
        * 输入的值
        */
-      value?: any;
+      value?: any
     }
 
     type SortOption = 'ascending' | 'descending' | null
 
+    /**
+     * 工具栏事件
+     */
+    type ToolBoxEvent =
+      | 'export'
+      | 'fullscreen'
+      | 'colunm-tool'
+      | 'filter'
+      | 'sort'
+
     /**
      * 列排序参数
      */
     type TableColumnSortParamsItem = {
-      prop: string;
-      order?: SortOption;
-      label?: string;
+      prop: string
+      order?: SortOption
+      label?: string
     }
 
     type TableProps = {
-      size?: Size;
-      border?: boolean;
-      resizable?: boolean;
-      elementLoadingText?: string;
-      height?: string | number;
-      maxHeight?: string | number;
-      fit?: boolean;
-      stripe?: boolean;
-      rowKey?: string;
-      showHeader?: boolean;
-      showSummary?: boolean;
-      sumText?: string;
-      summaryMethod?: AnyFunction;
-      rowClassName?: string | AnyFunction;
-      rowStyle?: AnyObject | AnyFunction;
-      cellClassName?: string | AnyFunction;
-      cellStyle?: AnyObject | AnyFunction;
-      headerRowClassName?: string | AnyFunction;
-      headerRowStyle?: AnyObject | AnyFunction;
-      headerCellClassName?: string | AnyFunction;
-      headerCellStyle?: AnyObject | AnyFunction;
-      highlightCurrentRow?: boolean;
-      currentRowKey?: string | number;
-      emptyText?: string;
-      expandRowKeys?: any[];
-      defaultExpandAll?: boolean;
-      defaultSort?: Sort;
-      tooltipEffect?: string;
-      spanMethod?: AnyFunction;
-      selectOnIndeterminate?: boolean;
-      indent?: number;
+      size?: Size
+      border?: boolean
+      resizable?: boolean
+      elementLoadingText?: string
+      height?: string | number
+      maxHeight?: string | number
+      fit?: boolean
+      stripe?: boolean
+      rowKey?: string
+      showHeader?: boolean
+      showSummary?: boolean
+      sumText?: string
+      summaryMethod?: AnyFunction
+      rowClassName?: string | AnyFunction
+      rowStyle?: AnyObject | AnyFunction
+      cellClassName?: string | AnyFunction
+      cellStyle?: AnyObject | AnyFunction
+      headerRowClassName?: string | AnyFunction
+      headerRowStyle?: AnyObject | AnyFunction
+      headerCellClassName?: string | AnyFunction
+      headerCellStyle?: AnyObject | AnyFunction
+      highlightCurrentRow?: boolean
+      currentRowKey?: string | number
+      emptyText?: string
+      expandRowKeys?: any[]
+      defaultExpandAll?: boolean
+      defaultSort?: Sort
+      tooltipEffect?: string
+      spanMethod?: AnyFunction
+      selectOnIndeterminate?: boolean
+      indent?: number
       treeProps?: {
-        hasChildren?: string;
-        children?: string;
-      };
-      lazy?: boolean;
-      load?: AnyFunction;
-      _customSummary?: boolean;
+        hasChildren?: string
+        children?: string
+      }
+      lazy?: boolean
+      load?: AnyFunction
+      _customSummary?: boolean
     }
 
     type TableEvents<MODEL = any> = {
-      select?:	(selection: any[], row: MODEL) => void;
-      selectAll?: (selection: any[]) => void;
-      selectionChange?: (selection: any[]) => void;
-      cellMouseEnter?: (row: MODEL, column: any, cell: any, event: any) => void;
-      cellMouseLeave?: (row: MODEL, column: any, cell: any, event: any) => void;
-      cellClick?: (row: MODEL, column: any, cell: any, event: any) => void;
-      cellDblclick?: (row: MODEL, column: any, cell: any, event: any) => void;
-      rowClick?: (row: MODEL, column: any, event: any) => void;
-      rowContextmenu?: (row: MODEL, column: any, event: any) => void;
-      rowDblclick?: (row: MODEL, column: any, event: any) => void;
-      headerClick?: (row: MODEL, column: any, event: any) => void;
-      headerContextmenu?: (column: any, event: any) => void;
-      sortChange?: ({ column, prop, order }: { column: any, prop: string, order: SortOption }) => void;
-      filterChange?: (filters: any[]) => void;
-      currentChange?: (currentRow: MODEL, oldCurrentRow: MODEL) => void;
-      headerDragend?: (newWidth: number, oldWidth: number, column: any, event: any) => void;
-      expandChange?: (row: MODEL, expanded: any) => void;
+      select?: (selection: any[], row: MODEL) => void
+      selectAll?: (selection: any[]) => void
+      selectionChange?: (selection: any[]) => void
+      cellMouseEnter?: (row: MODEL, column: any, cell: any, event: any) => void
+      cellMouseLeave?: (row: MODEL, column: any, cell: any, event: any) => void
+      cellClick?: (row: MODEL, column: any, cell: any, event: any) => void
+      cellDblclick?: (row: MODEL, column: any, cell: any, event: any) => void
+      rowClick?: (row: MODEL, column: any, event: any) => void
+      rowContextmenu?: (row: MODEL, column: any, event: any) => void
+      rowDblclick?: (row: MODEL, column: any, event: any) => void
+      headerClick?: (row: MODEL, column: any, event: any) => void
+      headerContextmenu?: (column: any, event: any) => void
+      sortChange?: ({
+        column,
+        prop,
+        order,
+      }: {
+        column: any
+        prop: string
+        order: SortOption
+      }) => void
+      filterChange?: (filters: any[]) => void
+      currentChange?: (currentRow: MODEL, oldCurrentRow: MODEL) => void
+      headerDragend?: (
+        newWidth: number,
+        oldWidth: number,
+        column: any,
+        event: any
+      ) => void
+      expandChange?: (row: MODEL, expanded: any) => void
     }
 
     type Table<MODEL = any, CTX = any> = {
-      els: TableBaseItem<MODEL, CTX>[];
-      pagination?: Pagination;
-      loadingDirectiveName?: string;
-      props?: ConvertFunctionContext<TableProps, CTX>;
+      els: TableBaseItem<MODEL, CTX>[]
+      pagination?: Pagination
+      loadingDirectiveName?: string
+      props?: ConvertFunctionContext<TableProps, CTX>
       events?: ConvertFunctionContext<TableEvents<MODEL>, CTX>
       /**
        * 是否可拖拽
        */
-      dragable?: boolean;
+      dragable?: boolean
 
       /**
        * 是否保存列筛选
        */
-      saveFilter?: boolean;
+      saveFilter?: boolean
 
       /**
        * 是否保存列排序
        */
-      saveSort?: boolean;
+      saveSort?: boolean
 
       /**
        * 显示工具列
        */
-      showTools?: boolean;
+      showTools?: boolean
       /**
        * 是否显示汇总
        */
-      showSummary?: boolean;
+      showSummary?: boolean
       /**
        * 显示索引列
        */
-      showIndex?: boolean;
+      showIndex?: boolean
       /**
        * 显示多选条数提示
        */
-      showSelectableTip?: boolean;
+      showSelectableTip?: boolean
       /**
        * 是否多选
        */
-      selectable?: boolean;
+      selectable?: boolean
       /**
        * 点击行自动选中
        */
-      rowClickSelect?: boolean;
+      rowClickSelect?: boolean
       /**
        * 多选的操作按钮
        */
-      selectableButtons?: Button<MODEL, CTX>[];
+      selectableButtons?: Button<MODEL, CTX>[]
       /**
        * 多选操作独自存活
        */
-      selectableButtonLiveAlone?: boolean;
+      selectableButtonLiveAlone?: boolean
       /**
        * 开启单选
        */
-      showRadio?: boolean;
+      showRadio?: boolean
       // 是否可编辑
-      editable?: boolean;
+      editable?: boolean
       // 汇总结果处理
-      summaryProcessFn?: (...rest: any[]) => any;
+      summaryProcessFn?: (...rest: any[]) => any
       /**
        * 汇总过程处理
-       * @param this 
+       * @param this
        * @param data 数据列表
        * @param prop 当前列表的prop
        * @param summaryType 合计类型 1累加 2汇总条数
-       * @returns 
+       * @returns
        */
-      summaryItemFn?: (this: any, data: any[], prop: string, summaryType: number) => any;
+      summaryItemFn?: (
+        this: any,
+        data: any[],
+        prop: string,
+        summaryType: number
+      ) => any
       // 本地筛选工具
-      showStaticFilter?: boolean;
+      showStaticFilter?: boolean
       // 保存筛选到本地
-      saveStaticFilter?: boolean;
+      saveStaticFilter?: boolean
       // xlsx配置
       xlsx?: {
         // 单元格合并规则
-        mergeFn?: (this: TableManager, exportData: MODEL[], columns: TableBaseItem<MODEL, CTX>[]) => { s: { r: number, c: number }, e: { r: number, c: number } }[]
-      };
+        mergeFn?: (
+          this: TableManager,
+          exportData: MODEL[],
+          columns: TableBaseItem<MODEL, CTX>[]
+        ) => { s: { r: number; c: number }; e: { r: number; c: number } }[]
+      }
 
       /**
        * 提供外部多选导出数据
@@ -211,40 +246,61 @@ declare global {
        * 操作栏
        */
       operate?: {
-        width?: string | number;
-        els: Button<MODEL, CTX>[];
-        props?: TableBaseItemProps;
-      };
+        width?: string | number
+        els: Button<MODEL, CTX>[]
+        props?: TableBaseItemProps
+      }
+
+      /**
+       * 上下文菜单
+       */
+      contextMenu?: {
+        /**
+         * 是否包含操作栏
+         */
+        containOperation?: boolean
+        /**
+         * 其它项
+         */
+        els?: Button<MODEL, CTX>[]
+      }
+
       /**
        * 工具箱
        */
-      toolbox?: ('export' | 'fullscreen' | 'colunm-tool' | 'filter' | 'sort')[]
+      toolbox?: ToolBoxEvent[]
 
       /**
        * 工具栏显示模式
        */
-      toolboxShowMode?: 'button' | 'icon';
+      toolboxShowMode?: 'button' | 'icon'
 
       /**
        * 扩展工具栏
        */
       extendsToolbox?: {
-        icon: Component;
-        text?: string;
-        event: string;
+        icon: Component
+        text?: string
+        event: string
       }[]
       /**
        * 列筛选参数处理函数
        */
-      columnParamsProcessFn?: (this: TableManager, paramsList: PageModel.TableColumnParamsItem[]) => unknown
+      columnParamsProcessFn?: (
+        this: TableManager,
+        paramsList: PageModel.TableColumnParamsItem[]
+      ) => unknown
       /**
        * 列筛选参数查询立即执行
        */
-      columnParamsQueryImmediate?: boolean;
+      columnParamsQueryImmediate?: boolean
       /**
        * 列排序参数处理函数
        */
-      columnSortParamsProcessFn?: (this: TableManager, sortParamsList: PageModel.TableColumnSortParamsItem[]) => unknown
+      columnSortParamsProcessFn?: (
+        this: TableManager,
+        sortParamsList: PageModel.TableColumnSortParamsItem[]
+      ) => unknown
     }
   }
 }