ele-admin-plus 1.1.9-beta.8 → 1.1.9

package/es/ele-pro-table/types.d.ts

@@ -1,8 +1,12 @@
 import type {
   EleDataTableInstance,
   EleVirtualTableInstance,
-  ElePaginationProps
+  ElePaginationProps,
+  EleModalProps,
+  ElePrinterProps,
+  EleTableProps
 } from '../ele-app/plus';
+import type { PaginationTotal } from '../ele-pagination/types';
 import type {
   DataItem,
   Column,
@@ -13,6 +17,7 @@ import type {
   TableSize,
   ResolveFunction
 } from '../ele-data-table/types';
+import type { BodyColumns } from '../ele-virtual-table/types';
 export type {
   DataItem,
   Column,
@@ -24,6 +29,11 @@ export type {
   ResolveFunction
 };
 
+/**
+ * 分页参数
+ */
+export type Pages = Record<string, number>;
+
 /**
  * 搜索参数
  */
@@ -47,6 +57,8 @@ export interface DatasourceParams {
   page?: number;
   /** 每页显示数量 */
   limit?: number;
+  /** 分页参数 */
+  pages: Pages;
   /** 搜索参数 */
   where: Where;
   /** 排序参数 */
@@ -116,6 +128,10 @@ export type OrderValue = string | number | boolean | null | undefined;
  * 请求参数设置
  */
 export interface RequestOption {
+  /** 页码参数名称 */
+  pageName?: string;
+  /** 每页数量参数名称 */
+  limitName?: string;
   /** 排序字段参数名称 */
   sortName?: string;
   /** 排序方式参数名称 */
@@ -137,7 +153,7 @@ export interface ResponseOption {
 }
 
 /**
- * 响应数据解析
+ * 响应数据解析方法
  */
 export type ParseData = (data: unknown) => DatasourceResult;
 
@@ -159,10 +175,10 @@ export interface OrderItem {
 export interface DoneParams<T> {
   /** 当前页数据 */
   data: T[];
+  /** 总数量 */
+  total?: PaginationTotal;
   /** 当前页码 */
   page?: number;
-  /** 总数量 */
-  total?: number;
   /** 数据源原始数据 */
   response?: any;
 }
@@ -188,7 +204,14 @@ export interface TablePagination extends ElePaginationProps {
 /**
  * 内置工具按钮
  */
-export type TableTool = 'reload' | 'size' | 'columns' | 'maximized' | string;
+export type TableTool =
+  | 'reload'
+  | 'size'
+  | 'columns'
+  | 'maximized'
+  | 'export'
+  | 'print'
+  | string;
 
 /**
  * 列配置
@@ -211,6 +234,11 @@ export interface ColItem {
  */
 export type FetchCallback = (options: DatasourceParams) => void;
 
+/**
+ * 请求方法
+ */
+export type FetchFunction = (callback: FetchCallback) => void;
+
 /**
  * 前端分页排序方法返回结果
  */
@@ -258,6 +286,122 @@ export type TableViewInstance =
   | EleVirtualTableInstance
   | null;
 
+/**
+ * 导出的数据来源类型
+ */
+export type ExportDataType = 'selections' | 'pageData' | 'data';
+
+/**
+ * 导出的数据每一项
+ */
+export interface ExportDataItem {
+  /** 唯一值 */
+  key?: string;
+  /** 行数据 */
+  row?: DataItem;
+  /** 行索引 */
+  index: number;
+  /** 列配置 */
+  column?: Column;
+  /** 文本 */
+  text?: string;
+  /** 所占列数 */
+  colspan?: number;
+  /** 所占行数 */
+  rowspan?: number;
+}
+
+/**
+ * 导出数据封装返回结果
+ */
+export interface ExportDataResult {
+  /** 表头数据 */
+  headerData: ExportDataItem[][];
+  /** 主体数据 */
+  bodyData: ExportDataItem[][];
+  /** 表尾数据 */
+  footerData: ExportDataItem[][];
+  /** 主体列配置 */
+  bodyCols: BodyColumns;
+}
+
+/**
+ * 导出数据前的钩子函数的参数
+ */
+export interface BeforeExportParams {
+  /** 导出的数据 */
+  data: DataItem[];
+  /** 导出的列配置 */
+  columns?: Columns;
+  /** 导出的表头数据封装 */
+  headerData: ExportDataItem[][];
+  /** 导出的主体数据封装 */
+  bodyData: ExportDataItem[][];
+  /** 导出的页脚数据封装 */
+  footerData: ExportDataItem[][];
+  /** 主体列配置 */
+  bodyCols: BodyColumns;
+  /** 文件名 */
+  fileName?: string;
+  /** 关闭确定按钮的加载状态 */
+  hideLoading: () => void;
+  /** 关闭弹窗 */
+  closeModal: () => void;
+}
+
+/**
+ * 导出数据前的钩子函数
+ */
+export type BeforeExport = (params: BeforeExportParams) => boolean | void;
+
+/**
+ * 导出配置
+ */
+export interface ExportConfig {
+  /** 弹窗参数 */
+  modalProps?: EleModalProps;
+  /** 表格全部数据 */
+  datasource?: Datasource;
+  /** 导出前的钩子函数 */
+  beforeExport?: BeforeExport;
+  /** 默认数据类型 */
+  dataType?: ExportDataType;
+  /** 默认文件名 */
+  fileName?: string;
+}
+
+/**
+ * 打印配置
+ */
+export interface PrintConfig {
+  /** 弹窗参数 */
+  modalProps?: EleModalProps;
+  /** 打印组件参数 */
+  printerProps?: ElePrinterProps;
+  /** 打印表格参数 */
+  tableProps?: EleTableProps;
+  /** 表格全部数据 */
+  datasource?: Datasource;
+  /** 打印前的钩子函数 */
+  beforePrint?: BeforeExport;
+  /** 默认数据类型 */
+  dataType?: ExportDataType;
+}
+
+/**
+ * 打印参数
+ */
+export interface TablePrintOptions extends ExportDataResult {
+  /** 是否开始打印 */
+  printing: boolean;
+  /** 是否有表头 */
+  hasHeader: boolean;
+  /** 是否有表尾 */
+  hasFooter: boolean;
+  /** 打印的数据 */
+  data: DataItem[];
+}
+
 /**
  * 国际化
  */
@@ -266,6 +410,8 @@ export interface TableLocale {
   sizes: string;
   columns: string;
   maximized: string;
+  export: string;
+  print: string;
   sizeLarge: string;
   sizeDefault: string;
   sizeSmall: string;
@@ -274,4 +420,13 @@ export interface TableLocale {
   columnUntitled: string;
   columnFixedLeft: string;
   columnFixedRight: string;
+  exportOk: string;
+  exportCancel: string;
+  exportFileName: string;
+  exportFileNamePlaceholder: string;
+  exportSelectData: string;
+  exportSelectColumn: string;
+  exportDataTypePage: string;
+  exportDataTypeSelected: string;
+  exportDataTypeAll: string;
 }

package/es/ele-pro-table/util.d.ts

@@ -1,6 +1,7 @@
-import type { ElePaginationProps } from '../ele-app/plus';
-import type { DataItem, Column, Columns, Sorter, Filter, TableSize, TreeProps, RowKey } from '../ele-data-table/types';
-import type { Orders, Filters, OrderItem, RequestOption, ResponseOption, TablePagination, DatasourceResult, ResponseResult, ReloadDataResult, ColItem, ProProps } from './types';
+import { Pages, Orders, Filters, OrderItem, RequestOption, ResponseOption, TablePagination, DatasourceResult, ResponseResult, ReloadDataResult, ColItem, ProProps, ExportDataItem, ExportDataResult } from './types';
+import { DataItem, Column, Columns, Sorter, Filter, TableSize, TreeProps, RowKey, SpanMethod, SummaryMethod } from '../ele-data-table/types';
+import { ElePaginationProps } from '../ele-app/plus';
+
 /**
  * 合并复合属性
  * @param props 属性
@@ -26,7 +27,7 @@ export declare function getTableLimit(pagination: boolean | TablePagination | un
  * @param globalPagination 全局配置分页组件属性
  * @param pageProps 分页相关的属性
  */
-export declare function getPaginationProps(size: TableSize, pagination: boolean | TablePagination | undefined, globalPagination: boolean | TablePagination | undefined, pageProps?: Pick<ElePaginationProps, 'total' | 'pageSize' | 'currentPage'>): ElePaginationProps | null;
+export declare function getPaginationProps(size: TableSize, pagination: boolean | TablePagination | undefined, globalPagination: boolean | TablePagination | undefined, pageProps?: Pick<ElePaginationProps, 'total' | 'pageSize' | 'currentPage' | 'hasNext'>): ElePaginationProps | null;
 /**
  * 判断是否开启自动修正页码
  * @param pagination 分页组件属性
@@ -74,6 +75,14 @@ export declare function getRequestOrders(sorter?: Sorter, request?: RequestOptio
  * @param filter 筛选条件
  */
 export declare function getRequestFilters(filter?: Filter): Filters;
+/**
+ * 生成请求的分页参数
+ * @param page 页码
+ * @param limit 每页数量
+ * @param request 请求参数配置
+ * @param globalRequest 全局请求参数配置
+ */
+export declare function getRequestPages(page: number, limit: number, request?: RequestOption, globalRequest?: RequestOption): Pages;
 /**
  * 获取数据源请求结果
  * @param data 数据源请求的原始数据
@@ -108,7 +117,7 @@ export declare function sortData(datasource?: DataItem[], sorter?: Sorter): Data
  * 获取列配置标识
  * @param column 列数据
  */
-export declare function getColId(column?: Column): string | undefined;
+export declare function getColId(column: Column): string | undefined;
 /**
  * 获取初始显示的列数据
  * @param columns 列数据
@@ -127,7 +136,16 @@ export declare function getInitCacheColumns(columns: Columns, cacheKey?: string,
  * @param cols 列配置数据
  * @param sortable 是否进行排序
  */
-export declare function getCheckedColumns(columns: Columns | undefined, cols: ColItem[], sortable?: boolean): Columns;
+export declare function getCheckedColumns(columns: Columns | undefined, cols: ColItem[], sortable?: boolean, filter?: (item: Column) => boolean): Columns;
+/**
+ * 获取列展示列表数据
+ * @param columns 列配置
+ * @param untitledText 未命名列文字
+ * @param filter 过滤列的方法
+ * @param sortFixed 是否对固定列排序
+ * @param cancelFixed 是否取消固定列
+ */
+export declare function getColItems(columns?: Columns, untitledText?: string, filter?: (item: Column) => boolean, sortFixed?: boolean, cancelFixed?: boolean): ColItem[];
 /**
  * 获取列配置
  * @param columns 列数据
@@ -154,19 +172,49 @@ export declare function getSizeCacheKey(cacheKey: string): string;
  */
 export declare function getCacheSize(cacheKey?: string): TableSize;
 /**
- * 获取默认 rowKey
+ * 获取 rowKey
  * @param rowKey 自定义 rowKey
  */
-export declare function getDefaultRowKey(rowKey?: RowKey): "_rowKey" | undefined;
+export declare function getRowKey(rowKey?: RowKey): string | ((row: DataItem) => string);
 /**
- * 获取 rowKey
- * @param rowKey 自定义 rowKey
+ * 导出获取单元格文本
+ * @param column 列配置
+ * @param row 行数据
+ * @param index 行索引
+ * @param pageIndex 序号列起始索引
  */
-export declare function getRowKey(rowKey?: RowKey): string | ((row: DataItem) => string) | undefined;
+export declare function getCellText(column: Column | undefined, row: DataItem, index: number, pageIndex?: number): string;
 /**
- * 数据添加默认的 rowKey 字段
- * @param data 数据
- * @param rowKey 字段名
- * @param page 页码
+ * 导出获取表头单元格文本
+ * @param column 列配置
+ * @param index 行索引
+ */
+export declare function getHeaderCellText(column: Column | undefined, index: number): string;
+/**
+ * 获取导出的数据
+ * @param data 元数据
+ * @param columns 列配置
+ * @param spanMethod 单元格合并方法
+ * @param pageIndex 序号列起始索引
+ * @param showSummary 是否显示合计行
+ * @param sumText 合计行文本
+ * @param summaryMethod 合计行自定义方法
+ */
+export declare function getExportData(data: DataItem[], columns: Columns, spanMethod?: SpanMethod, pageIndex?: number, showSummary?: boolean, sumText?: string, summaryMethod?: SummaryMethod): ExportDataResult;
+/**
+ * 导出csv文件
+ * @param fileName 文件名
+ * @param headerData 表头数据
+ * @param bodyData 主体数据
+ */
+export declare function exportCSV(fileName: string, headerData: ExportDataItem[][], bodyData: ExportDataItem[][], footerData: ExportDataItem[][]): void;
+/**
+ * 导出判断列是否显示
+ * @param item 列配置
+ */
+export declare function columnsExportFilter(item: Column): boolean;
+/**
+ * 打印判断列是否显示
+ * @param item 列配置
  */
-export declare function addDefaultRowKey(data: DataItem[], rowKey: string | undefined, page: number): DataItem[];
+export declare function columnsPrintFilter(item: Column): boolean;

package/es/ele-pro-table/util.js

@@ -1,5 +1,6 @@
-import { getValue } from "../ele-data-table/util";
-import { omit, eachTree, uuid, mapTree } from "../utils/core";
+import { omit, eachTree, findTree, uuid, mapTree } from "../utils/core";
+import { getValue, getColFixedNumber } from "../ele-data-table/util";
+import { getIndexValue, analyseColumns, getCellSpan, getUserSums, getSumValue } from "../ele-virtual-table/util";
 function mergeProps(props, globalProps) {
   if (props == null) {
     return globalProps ?? true;
@@ -64,6 +65,8 @@ function getDefaultFilter(columns) {
 }
 function getRequestName(globalRequest, request) {
   const defaultRequest = {
+    pageName: "page",
+    limitName: "limit",
     sortName: "sort",
     orderName: "order",
     ascValue: "asc",
@@ -142,6 +145,16 @@ function getRequestFilters(filter) {
   }
   return filters;
 }
+function getRequestPages(page, limit, request, globalRequest) {
+  const pages = {};
+  const { pageName, limitName } = getRequestName(globalRequest, request);
+  if (!pageName || !limitName) {
+    return pages;
+  }
+  pages[pageName] = page;
+  pages[limitName] = limit;
+  return pages;
+}
 function getResponseResult(data, response, globalResponse, lazy, treeOpt) {
   if (!data || Array.isArray(data)) {
     return { data: getResponseData(data, lazy, treeOpt) };
@@ -204,7 +217,10 @@ function sortData(datasource, sorter) {
   return data;
 }
 function getColId(column) {
-  return column ? column.columnKey || column.prop : void 0;
+  if (column.columnKey == null || column.columnKey === "") {
+    return column.prop;
+  }
+  return column.columnKey;
 }
 function getInitColumns(columns) {
   const data = [];
@@ -230,7 +246,7 @@ function getInitCacheColumns(columns, cacheKey, sortable) {
   }
   return getCheckedColumns(columns, cache, sortable);
 }
-function getCheckedColumns(columns, cols, sortable) {
+function getCheckedColumns(columns, cols, sortable, filter) {
   const data = [];
   if (!columns || !columns.length) {
     return data;
@@ -240,26 +256,23 @@ function getCheckedColumns(columns, cols, sortable) {
     if (colId == null) {
       return;
     }
-    let temp;
-    eachTree(cols, (t) => {
-      if (t.uid === colId) {
-        temp = t;
-        return false;
-      }
-    });
+    if (filter && !filter(d)) {
+      return;
+    }
+    const temp = findTree(cols, (t) => t.uid === colId);
     if (temp && !temp.checked) {
       return;
     }
     const fixed = (temp == null ? void 0 : temp.fixed) ?? d.fixed;
     const uid = uuid(8);
-    if (d.children) {
-      const children = getCheckedColumns(d.children, cols, sortable);
+    if (d.children && d.children.length) {
+      const children = getCheckedColumns(d.children, cols, sortable, filter);
       if (children.length) {
         data.push({ ...d, fixed, uid, children });
       }
-    } else {
-      data.push({ ...d, fixed, uid });
+      return;
     }
+    data.push({ ...d, fixed, uid });
   });
   if (!sortable || !data.length) {
     return data;
@@ -305,6 +318,28 @@ function getCheckedColumns(columns, cols, sortable) {
   });
   return data;
 }
+function getColItems(columns, untitledText, filter, sortFixed, cancelFixed) {
+  const temp = columns == null ? [] : [...columns];
+  if (sortFixed) {
+    temp.sort((a, b) => {
+      return getColFixedNumber(a.fixed) - getColFixedNumber(b.fixed);
+    });
+  }
+  return mapTree(temp, (d, _i, parent) => {
+    const colId = getColId(d);
+    if (colId == null || filter && !filter(d)) {
+      return;
+    }
+    return {
+      uid: colId,
+      //prop: d.prop,
+      //columnKey: d.columnKey,
+      label: d.label || untitledText,
+      checked: !d.hideInTable,
+      fixed: cancelFixed ? false : parent == null ? d.fixed : false
+    };
+  });
+}
 function getSettingCols(columns, untitledText, cacheKey) {
   const cacheResult = getCacheCols(cacheKey);
   if (cacheResult) {
@@ -359,31 +394,122 @@ function getCacheSize(cacheKey) {
     }
   }
 }
-function getDefaultRowKey(rowKey) {
-  return rowKey ? void 0 : "_rowKey";
-}
 function getRowKey(rowKey) {
-  return rowKey ?? getDefaultRowKey();
+  if (rowKey != null) {
+    return rowKey;
+  }
+  return (row) => {
+    return JSON.stringify(row);
+  };
 }
-function addDefaultRowKey(data, rowKey, page) {
-  if (rowKey == null) {
-    return data;
+function getCellText(column, row, index, pageIndex) {
+  if (!column) {
+    return "";
   }
-  return data.map((d, i) => {
-    const item = { ...d };
-    item[rowKey] = `${page}-${i}`;
-    return item;
+  if (column.type === "index") {
+    return getIndexValue(index, column.index, pageIndex);
+  }
+  const propValue = getValue(row, column.prop);
+  if (typeof column.formatter === "function") {
+    return column.formatter(row, column, propValue, index);
+  }
+  return propValue == null ? "" : String(propValue);
+}
+function getHeaderCellText(column, index) {
+  if (!column) {
+    return "";
+  }
+  if (typeof column.renderHeader === "function") {
+    return column.renderHeader({ column, $index: index });
+  }
+  return column.label == null ? "" : String(column.label);
+}
+function getExportData(data, columns, spanMethod, pageIndex, showSummary, sumText, summaryMethod) {
+  const { rows: headerRows, cols: bodyCols } = analyseColumns(columns);
+  const bodyData = [];
+  data.forEach((row, index) => {
+    const bodyRowData = [];
+    bodyCols.forEach((col, columnIndex) => {
+      const { key, originalCol: column } = col;
+      const { colspan, rowspan } = getCellSpan(
+        { column, columnIndex, row, rowIndex: index },
+        spanMethod
+      );
+      const isNone = colspan == 0 || rowspan == 0;
+      const text = isNone ? "" : getCellText(column, row, index, pageIndex);
+      bodyRowData.push({ key, row, index, column, text, colspan, rowspan });
+    });
+    bodyData.push(bodyRowData);
   });
+  const headerData = [];
+  headerRows.forEach((headerCols, index) => {
+    const headerRowData = [];
+    headerCols.forEach((col) => {
+      const { key, colspan, rowspan, originalCol: column } = col;
+      const isNone = colspan == 0 || rowspan == 0;
+      const text = isNone ? "" : getHeaderCellText(column, index);
+      headerRowData.push({ key, index, column, text, colspan, rowspan });
+    });
+    headerData.push(headerRowData);
+  });
+  const footerData = [];
+  if (showSummary && data.length) {
+    const footerRowData = [];
+    const userSums = getUserSums(summaryMethod, bodyCols, data);
+    bodyCols.forEach((col, i) => {
+      const { key, dataKey, originalCol: column } = col;
+      const sumValue = getSumValue(data, dataKey);
+      footerRowData.push({
+        key,
+        column,
+        text: userSums == null ? i === 0 ? sumText : sumValue : userSums[i],
+        index: 0
+      });
+    });
+    footerData.push(footerRowData);
+  }
+  return { headerData, bodyData, footerData, bodyCols };
+}
+function exportCSV(fileName, headerData, bodyData, footerData) {
+  const csvRows = [];
+  [...headerData, ...bodyData, ...footerData].forEach((item) => {
+    csvRows.push(item.map((d) => d.text ?? "").join(","));
+  });
+  const content = encodeURIComponent(csvRows.join("\n"));
+  const a = document.createElement("a");
+  a.href = "data:text/csv;charset=utf-8," + content;
+  a.download = fileName + ".csv";
+  a.style.display = "none";
+  document.body.appendChild(a);
+  a.click();
+  document.body.removeChild(a);
+}
+function columnsExportFilter(item) {
+  if (item.hideInExport) {
+    return false;
+  }
+  return !item.type || !["selection", "expand"].includes(item.type);
+}
+function columnsPrintFilter(item) {
+  if (item.hideInPrint) {
+    return false;
+  }
+  return !item.type || !["selection", "expand"].includes(item.type);
 }
 export {
-  addDefaultRowKey,
+  columnsExportFilter,
+  columnsPrintFilter,
+  exportCSV,
   getCacheCols,
   getCacheSize,
+  getCellText,
   getCheckedColumns,
   getColId,
+  getColItems,
   getColsCacheKey,
   getDefaultFilter,
-  getDefaultRowKey,
+  getExportData,
+  getHeaderCellText,
   getInitCacheColumns,
   getInitColumns,
   getOrderItems,
@@ -391,6 +517,7 @@ export {
   getRequestFilters,
   getRequestName,
   getRequestOrders,
+  getRequestPages,
   getResponseData,
   getResponseName,
   getResponseResult,

package/es/ele-qr-code/index.d.ts

@@ -1,12 +1,13 @@
-import type { StyleValues } from '../ele-app/types';
-declare const _default: import("vue").DefineComponent<{
+import { StyleValues } from '../ele-app/types';
+
+declare const _default: import('vue').DefineComponent<{
     value: StringConstructor;
     size: {
         type: NumberConstructor;
         default: number;
     };
     level: {
-        type: import("vue").PropType<import("./types").Level>;
+        type: import('vue').PropType<import('./types').Level>;
         default: string;
     };
     bgColor: {
@@ -21,24 +22,24 @@ declare const _default: import("vue").DefineComponent<{
         type: NumberConstructor;
         default: number;
     };
-    imageSettings: import("vue").PropType<import("./types").ImageSettings>;
-    customStyle: import("vue").PropType<Partial<import("vue").CSSProperties>>;
+    imageSettings: import('vue').PropType<import('./types').ImageSettings>;
+    customStyle: import('vue').PropType<Partial<import('vue').CSSProperties>>;
 }, {
-    canvasRef: import("vue").Ref<HTMLCanvasElement | null>;
-    imageRef: import("vue").Ref<HTMLImageElement | null>;
-    imageSrc: import("vue").ComputedRef<string | undefined>;
-    canvasStyle: import("vue").ComputedRef<StyleValues>;
+    canvasRef: import('vue').Ref<HTMLCanvasElement | null>;
+    imageRef: import('vue').Ref<HTMLImageElement | null>;
+    imageSrc: import('vue').ComputedRef<string | undefined>;
+    canvasStyle: import('vue').ComputedRef<StyleValues>;
     render: () => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     done: () => boolean;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
     value: StringConstructor;
     size: {
         type: NumberConstructor;
         default: number;
     };
     level: {
-        type: import("vue").PropType<import("./types").Level>;
+        type: import('vue').PropType<import('./types').Level>;
         default: string;
     };
     bgColor: {
@@ -53,14 +54,14 @@ declare const _default: import("vue").DefineComponent<{
         type: NumberConstructor;
         default: number;
     };
-    imageSettings: import("vue").PropType<import("./types").ImageSettings>;
-    customStyle: import("vue").PropType<Partial<import("vue").CSSProperties>>;
+    imageSettings: import('vue').PropType<import('./types').ImageSettings>;
+    customStyle: import('vue').PropType<Partial<import('vue').CSSProperties>>;
 }>> & {
     onDone?: (() => any) | undefined;
 }, {
     margin: number;
     size: number;
-    level: import("./types").Level;
+    level: import('./types').Level;
     bgColor: string;
     fgColor: string;
 }, {}>;