@juzhenfe/page-model 3.22.3 → 3.22.4

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

@@ -0,0 +1,364 @@
+import { PaginationProps, TableV2Props } from 'element-plus';
+import { Sort } from 'element-plus/es/components/table/src/table/defaults';
+import { default as TableManagerDefault } from './constructor';
+import { Component } from 'vue';
+import { FilterItemTypeEnum, FilterMatchModeEnum } from './components/table-column/components/filter-zone/utils';
+import { SummaryTypeEnum } from './utils/use-static-summary';
+
+
+declare global {
+  namespace PageModel {
+    type TableManager = TableManagerDefault
+
+    type Pagination = {
+      show?: boolean
+    } & Partial<PaginationProps>
+
+    type TableDataExportModel = {
+      data: any[]
+      columns: any[]
+      filename: string
+    }
+
+    /**
+     * 列筛选条件
+     */
+    type TableColumnParamsItem = {
+      /**
+       * 列的属性
+       */
+      prop: string
+      /**
+       * 过滤类型
+       */
+      filterType?: FilterItemTypeEnum
+      /**
+       * 筛选条件文本
+       */
+      filterLabel?: string
+      /**
+       * 筛选项
+       */
+      filterOptions?: Array<{ label: string; value: string | boolean | number }>
+      /**
+       * 当前条件
+       */
+      condition?: FilterMatchModeEnum
+      /**
+       * 输入的值
+       */
+      value?: any
+    }
+
+    type SortOption = 'ascending' | 'descending' | null
+
+    /**
+     * 工具栏事件
+     */
+    type ToolBoxEvent =
+      | 'export'
+      | 'fullscreen'
+      | 'column-tool'
+      | 'filter'
+      | 'sort'
+      | 'line-clamp'
+      | 'refresh'
+
+    /**
+     * 列排序参数
+     */
+    type TableColumnSortParamsItem = {
+      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
+      treeProps?: {
+        hasChildren?: string
+        children?: string
+      }
+      lazy?: boolean
+      load?: AnyFunction
+      /**
+       * pageModel定义合计函数
+       */
+      _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
+    }
+
+    type Table<MODEL = any, CTX = any> = {
+      els: TableBaseItem<MODEL, CTX>[]
+      pagination?: Pagination
+      loadingDirectiveName?: string
+      props?: ConvertFunctionContext<TableProps, CTX>
+      events?: ConvertFunctionContext<TableEvents<MODEL>, CTX>
+      /**
+       * 是否启用虚拟化表格（渲染 ElTableV2）
+       */
+      virtual?: boolean
+      /**
+       * 虚拟化表格的额外配置（透传给 ElTableV2）
+       */
+      virtualProps?: TableV2Props
+      /**
+       * 是否可拖拽
+       */
+      dragable?: boolean
+
+      /**
+       * 是否保存列筛选
+       */
+      saveFilter?: boolean
+
+      /**
+       * 是否保存列排序
+       */
+      saveSort?: boolean
+
+      /**
+       * 显示工具列
+       */
+      showTools?: boolean
+      /**
+       * 是否显示汇总
+       */
+      showSummary?: boolean
+      /**
+       * 显示索引列
+       */
+      showIndex?: boolean
+
+      /**
+       * 辅助横向滚动
+       */
+      assistScrollX?: boolean
+      
+      /**
+       * 显示多选条数提示
+       */
+      showSelectableTip?: boolean
+      /**
+       * 是否多选
+       */
+      selectable?: boolean
+      /**
+       * 点击行自动选中
+       */
+      rowClickSelect?: boolean
+      /**
+       * 多选的操作按钮
+       */
+      selectableButtons?: Button<MODEL, CTX>[]
+      /**
+       * 多选操作独自存活
+       */
+      selectableButtonLiveAlone?: boolean
+      /**
+       * 开启单选
+       */
+      showRadio?: boolean
+      // 是否可编辑
+      editable?: boolean
+
+      /**
+       * 是否开启服务端汇总
+       */
+      useServerSummary?: boolean
+
+      /**
+       * 服务端汇总请求方法
+       */
+      serverSummaryFn?: (this: TableManager, summaryColumns: { prop: string, showSummary: SummaryTypeEnum }[], reqParams: AnyObject, columns: any[]) => Promise<any[]>
+
+      /**
+       * 汇总过程处理，对每项进行处理
+       * @param this
+       * @param data 数据列表
+       * @param prop 当前列表的prop
+       * @param summaryType 合计类型 1累加 2总数
+       * @returns
+       */
+      summaryItemFn?: (
+        this: any,
+        data: any[],
+        prop: string,
+        summaryType: number
+      ) => any
+
+      /**
+       * @param rest 汇总结果处理
+       * @returns 
+       */
+      summaryProcessFn?: (this: any, summaryValue: any) => any
+      /**
+       * pageIndex key
+       */
+      pageIndexKey?: string
+
+      /**
+       * pageSize key
+       */
+      pageSizeKey?: string
+
+      /**
+       * api请求导出每次请求页数
+       */
+      exportPageSize?: number
+
+      /**
+       * 导出的文件默认名称
+       */
+      exportFileName?: string
+
+      /**
+       * 导出的提示文字可选列表
+       */
+      exportLoadingText?: string[]
+
+      // xlsx配置
+      xlsx?: {
+        // 单元格合并规则
+        mergeFn?: (
+          this: TableManager,
+          exportData: MODEL[],
+          columns: TableBaseItem<MODEL, CTX>[]
+        ) => { s: { r: number; c: number }; e: { r: number; c: number } }[]
+      }
+
+      /**
+       * 提供外部多选导出数据
+       */
+      getExportSelectableData?: (this: TableManager) => any[]
+
+      /**
+       * 操作栏
+       */
+      operate?: {
+        width?: string | number
+        els: Button<MODEL, CTX>[]
+        props?: TableBaseItemProps
+      }
+
+      /**
+       * 上下文菜单
+       */
+      contextMenu?: {
+        /**
+         * 是否包含操作栏
+         */
+        containOperation?: boolean
+        /**
+         * 其它项
+         */
+        els?: Button<MODEL, CTX>[]
+      }
+
+      /**
+       * 工具箱
+       */
+      toolbox?: ToolBoxEvent[]
+
+      /**
+       * 工具栏显示模式
+       */
+      toolboxShowMode?: 'button' | 'icon'
+
+      /**
+       * 扩展工具栏
+       */
+      extendsToolbox?: {
+        icon: Component
+        text?: string
+        event: string
+      }[]
+
+      /**
+       * 工具栏位置
+       */
+      toolboxPositon?: 'left' | 'right'
+
+      /**
+       * 列筛选参数处理函数
+       */
+      columnParamsProcessFn?: (
+        this: TableManager,
+        paramsList: PageModel.TableColumnParamsItem[]
+      ) => unknown
+      /**
+       * 列筛选参数查询立即执行
+       */
+      columnParamsQueryImmediate?: boolean
+      /**
+       * 列排序参数处理函数
+       */
+      columnSortParamsProcessFn?: (
+        this: TableManager,
+        sortParamsList: PageModel.TableColumnSortParamsItem[]
+      ) => unknown
+    }
+  }
+}

package/dist/index.es.js

@@ -9666,7 +9666,7 @@ var of = !1, sf = () => {
 	return D(e);
 }, wf = {
 	name: "@juzhenfe/page-model",
-	version: "3.22.3",
+	version: "3.22.4",
 	types: "dist/main.d.ts",
 	main: "dist/index.umd.js",
 	keywords: [