ele-admin-plus 1.2.0 → 1.2.1-beta.2

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

@@ -1,6 +1,6 @@
 import { ElePaginationProps } from '../ele-app/plus';
 import { DataItem, Column, Columns, Sorter, Filter, TableSize, TreeProps, RowKey, SpanMethod, SummaryMethod } from '../ele-data-table/types';
-import { Pages, Orders, Filters, OrderItem, RequestOption, ResponseOption, TablePagination, DatasourceResult, ResponseResult, ReloadDataResult, ColItem, ProProps, ExportBodyNode, ExportDataItem, ExportDataResult } from './types';
+import { Pages, Orders, Filters, OrderItem, RequestOption, ResponseOption, TablePagination, DatasourceResult, ResponseResult, ReloadDataResult, ColItem, ProProps, ExportBodyNode, ExportDataItem, ExportDataResult, TableLocale } from './types';
 
 /**
  * 合并复合属性
@@ -9,25 +9,25 @@ import { Pages, Orders, Filters, OrderItem, RequestOption, ResponseOption, Table
  */
 export declare function mergeProps<T extends Record<keyof any, any>>(props?: ProProps<T> | null, globalProps?: ProProps<T> | null): ProProps<T>;
 /**
- * 获取默认页码
+ * 获取分页组件属性
+ * @param size 表格尺寸
  * @param pagination 分页组件属性
  * @param globalPagination 全局配置分页组件属性
+ * @param pageProps 分页相关的属性
  */
-export declare function getTablePage(pagination: boolean | TablePagination | undefined, globalPagination: boolean | TablePagination | undefined): number;
+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 分页组件属性
  * @param globalPagination 全局配置分页组件属性
  */
-export declare function getTableLimit(pagination: boolean | TablePagination | undefined, globalPagination: boolean | TablePagination | undefined): number;
+export declare function getTablePage(pagination: boolean | TablePagination | undefined, globalPagination: boolean | TablePagination | undefined): number;
 /**
- * 获取分页组件属性
- * @param size 表格尺寸
+ * 获取默认每页数量
  * @param pagination 分页组件属性
  * @param globalPagination 全局配置分页组件属性
- * @param pageProps 分页相关的属性
  */
-export declare function getPaginationProps(size: TableSize, pagination: boolean | TablePagination | undefined, globalPagination: boolean | TablePagination | undefined, pageProps?: Pick<ElePaginationProps, 'total' | 'pageSize' | 'currentPage' | 'hasNext'>): ElePaginationProps | null;
+export declare function getTableLimit(pagination: boolean | TablePagination | undefined, globalPagination: boolean | TablePagination | undefined): number;
 /**
  * 判断是否开启自动修正页码
  * @param pagination 分页组件属性
@@ -54,8 +54,8 @@ export declare function getDefaultFilter(columns?: Columns): Filter;
 export declare function getRequestName(globalRequest?: RequestOption, request?: RequestOption): RequestOption;
 /**
  * 获取响应参数名称
- * @param globalRequest 全局响应参数配置
- * @param request 响应参数配置
+ * @param globalResponse 全局响应参数配置
+ * @param response 响应参数配置
  */
 export declare function getResponseName(globalResponse?: ResponseOption, response?: ResponseOption): ResponseOption;
 /**
@@ -100,19 +100,19 @@ export declare function getResponseResult(data: DatasourceResult, response?: Res
  */
 export declare function getResponseData(data?: DataItem[] | null, lazy?: boolean, treeProps?: TreeProps): DataItem[] | undefined;
 /**
- * 前端分页排序
+ * 排序数据
  * @param datasource 数据源
  * @param sorter 排序方式
- * @param page 页码
- * @param limit 每页数量
  */
-export declare function reloadData(datasource?: DataItem[], sorter?: Sorter, page?: number, limit?: number): ReloadDataResult;
+export declare function sortData(datasource?: DataItem[], sorter?: Sorter): DataItem[];
 /**
- * 排序数据
+ * 前端分页排序
  * @param datasource 数据源
  * @param sorter 排序方式
+ * @param page 页码
+ * @param limit 每页数量
  */
-export declare function sortData(datasource?: DataItem[], sorter?: Sorter): DataItem[];
+export declare function reloadData(datasource?: DataItem[], sorter?: Sorter, page?: number, limit?: number): ReloadDataResult;
 /**
  * 获取列配置标识
  * @param column 列数据
@@ -135,26 +135,25 @@ export declare function getInitCacheColumns(columns: Columns, cacheKey?: string,
  * @param columns 原始列数据
  * @param cols 列配置数据
  * @param sortable 是否进行排序
+ * @param isHideInCol 用于排序时计算不显示在配置中的列
+ * @param filter 强制过滤的列
+ * @param reserveUnchecked 是否保留未选中的列
  */
-export declare function getCheckedColumns(columns: Columns | undefined, cols: ColItem[], sortable?: boolean, filter?: (item: Column) => boolean): Columns;
+export declare function getCheckedColumns(columns: Columns | undefined, cols: ColItem[], sortable: boolean | undefined, isHideInCol: (item: Column) => boolean | undefined, filter?: (item: Column) => boolean, reserveUnchecked?: boolean): Columns;
 /**
  * 获取列展示列表数据
  * @param columns 列配置
- * @param untitledText 未命名列文字
- * @param indexText 序号列文字
- * @param expandText 展开列文字
+ * @param locale 国际化
  * @param filter 过滤列的方法
+ * @param cacheCols 缓存的列展示列表数据
  * @param sortFixed 是否对固定列排序
  * @param cancelFixed 是否取消固定列
  */
-export declare function getColItems(columns?: Columns, untitledText?: string, indexText?: string, expandText?: string, filter?: (item: Column) => boolean, sortFixed?: boolean, cancelFixed?: boolean): ColItem[];
-/**
- * 获取列配置
- * @param columns 列数据
- * @param untitledText 未命名列文字
- * @param cacheKey 缓存的名称
- */
-export declare function getSettingCols(columns?: Columns, untitledText?: string, cacheKey?: string): ColItem[];
+export declare function getColItems(columns: Columns | undefined, locale: TableLocale, filter?: (item: Column) => boolean, cacheCols?: ColItem[], sortFixed?: boolean, cancelFixed?: boolean): {
+    cols: ColItem[];
+    checkAll: boolean;
+    indeterminate: boolean;
+};
 /**
  * 获取缓存的列配置下拉列表数据
  * @param cacheKey 缓存的名称
@@ -162,10 +161,12 @@ export declare function getSettingCols(columns?: Columns, untitledText?: string,
 export declare function getCacheCols(cacheKey?: string): ColItem[] | undefined;
 /**
  * 获取列配置缓存的名称
+ * @param cacheKey 缓存的名称
  */
 export declare function getColsCacheKey(cacheKey: string): string;
 /**
  * 获取表格密度缓存的名称
+ * @param cacheKey 缓存的名称
  */
 export declare function getSizeCacheKey(cacheKey: string): string;
 /**
@@ -214,13 +215,15 @@ export declare function getExportBodyNode(data: DataItem[], childrenField?: stri
  * @param summaryMethod 合计行自定义方法
  * @param childrenField 子级字段名
  * @param showTreeIndex 是否显示层级序号
+ * @param showHeader 是否显示表头
  */
 export declare function getExportData(data: DataItem[], columns: Columns, spanMethod?: SpanMethod, pageIndex?: number, showSummary?: boolean, sumText?: string, summaryMethod?: SummaryMethod, childrenField?: string, showTreeIndex?: boolean, showHeader?: boolean): ExportDataResult;
 /**
- * 导出csv文件
+ * 导出 csv 文件
  * @param fileName 文件名
  * @param headerData 表头数据
  * @param bodyData 主体数据
+ * @param footerData 表尾数据
  */
 export declare function exportCSV(fileName: string, headerData: ExportDataItem[][], bodyData: ExportDataItem[][], footerData: ExportDataItem[][]): void;
 /**
@@ -233,3 +236,8 @@ export declare function columnsExportFilter(item: Column): boolean;
  * @param item 列配置
  */
 export declare function columnsPrintFilter(item: Column): boolean;
+/**
+ * 列配置判断列是否显示
+ * @param item 列配置
+ */
+export declare function columnsSettingFilter(item: Column): boolean;

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

@@ -16,14 +16,6 @@ function mergeProps(props, globalProps) {
   }
   return { ...globalProps, ...props };
 }
-function getTablePage(pagination, globalPagination) {
-  const props = getPaginationProps(void 0, pagination, globalPagination);
-  return (props == null ? void 0 : props.currentPage) ?? 1;
-}
-function getTableLimit(pagination, globalPagination) {
-  const props = getPaginationProps(void 0, pagination, globalPagination);
-  return (props == null ? void 0 : props.pageSize) ?? 10;
-}
 function getPaginationProps(size, pagination, globalPagination, pageProps) {
   const props = mergeProps(pagination, globalPagination);
   if (props == null || props === false) {
@@ -41,6 +33,14 @@ function getPaginationProps(size, pagination, globalPagination, pageProps) {
   }
   return Object.assign(defaultProps, omit(props, ["autoAmend"]), pageProps);
 }
+function getTablePage(pagination, globalPagination) {
+  const props = getPaginationProps(void 0, pagination, globalPagination);
+  return (props == null ? void 0 : props.currentPage) ?? 1;
+}
+function getTableLimit(pagination, globalPagination) {
+  const props = getPaginationProps(void 0, pagination, globalPagination);
+  return (props == null ? void 0 : props.pageSize) ?? 10;
+}
 function isAutoAmend(pagination, globalPagination) {
   const props = mergeProps(pagination, globalPagination);
   if (!props) {
@@ -180,21 +180,6 @@ function getResponseData(data, lazy, treeProps) {
     return temp;
   });
 }
-function reloadData(datasource, sorter, page, limit) {
-  const data = sortData(datasource, sorter);
-  const total = data.length;
-  if (!page || !limit) {
-    return { page: 1, data, total };
-  }
-  const maxPage = Math.ceil(total / limit);
-  if (maxPage && page > maxPage) {
-    page = maxPage;
-  }
-  const start = (page - 1) * limit;
-  const end = start + limit;
-  const list = data.slice(start, end > total ? total : end);
-  return { page, data: list, total };
-}
 function sortData(datasource, sorter) {
   if (!datasource || !datasource.length) {
     return [];
@@ -217,6 +202,21 @@ function sortData(datasource, sorter) {
   });
   return data;
 }
+function reloadData(datasource, sorter, page, limit) {
+  const data = sortData(datasource, sorter);
+  const total = data.length;
+  if (!page || !limit) {
+    return { page: 1, data, total };
+  }
+  const maxPage = Math.ceil(total / limit);
+  if (maxPage && page > maxPage) {
+    page = maxPage;
+  }
+  const start = (page - 1) * limit;
+  const end = start + limit;
+  const list = data.slice(start, end > total ? total : end);
+  return { page, data: list, total };
+}
 function getColId(column) {
   if (column.columnKey == null || column.columnKey === "") {
     return column.prop;
@@ -241,39 +241,49 @@ function getInitColumns(columns) {
   return data;
 }
 function getInitCacheColumns(columns, cacheKey, sortable) {
-  const cache = getCacheCols(cacheKey);
-  if (!cache) {
+  const cacheCols = getCacheCols(cacheKey);
+  if (!cacheCols) {
     return getInitColumns(columns);
   }
-  return getCheckedColumns(columns, cache, sortable);
+  return getCheckedColumns(
+    columns,
+    cacheCols,
+    sortable,
+    (item) => item.hideInSetting
+  );
 }
-function getCheckedColumns(columns, cols, sortable, filter) {
+function getCheckedColumns(columns, cols, sortable, isHideInCol, filter, reserveUnchecked) {
   const data = [];
   if (!columns || !columns.length) {
     return data;
   }
   columns.forEach((d) => {
     const colId = getColId(d);
-    if (colId == null) {
-      return;
-    }
     if (filter && !filter(d)) {
       return;
     }
-    const temp = findTree(cols, (t) => t.uid === colId);
-    if (temp && !temp.checked) {
+    const temp = colId == null ? null : findTree(cols, (t) => t.uid === colId);
+    const isUnchecked = temp ? !temp.checked : d.hideInTable;
+    if (!reserveUnchecked && isUnchecked) {
       return;
     }
     const fixed = (temp == null ? void 0 : temp.fixed) ?? d.fixed;
     const uid = uuid(8);
     if (d.children && d.children.length) {
-      const children = getCheckedColumns(d.children, cols, sortable, filter);
+      const children = getCheckedColumns(
+        d.children,
+        cols,
+        sortable,
+        isHideInCol,
+        filter,
+        reserveUnchecked
+      );
       if (children.length) {
-        data.push({ ...d, fixed, uid, children });
+        data.push({ ...d, fixed, hideInTable: isUnchecked, children, uid });
       }
       return;
     }
-    data.push({ ...d, fixed, uid });
+    data.push({ ...d, fixed, hideInTable: isUnchecked, uid });
   });
   if (!sortable || !data.length) {
     return data;
@@ -293,7 +303,7 @@ function getCheckedColumns(columns, cols, sortable, filter) {
       }
       i++;
     });
-    if (ai == null && a.hideInSetting && a.fixed === "right") {
+    if (ai == null && isHideInCol(a) && a.fixed === "right") {
       ai = i;
     }
     if (ai == null) {
@@ -301,10 +311,10 @@ function getCheckedColumns(columns, cols, sortable, filter) {
     }
     if (a.fixed === true || a.fixed === "left") {
       ai -= i;
-    } else if (a.fixed === "right" || a.hideInSetting && !a.fixed) {
+    } else if (a.fixed === "right" || isHideInCol(a) && !a.fixed) {
       ai += i;
     }
-    if (bi == null && b.hideInSetting && b.fixed === "right") {
+    if (bi == null && isHideInCol(b) && b.fixed === "right") {
       bi = i;
     }
     if (bi == null) {
@@ -312,70 +322,85 @@ function getCheckedColumns(columns, cols, sortable, filter) {
     }
     if (b.fixed === true || b.fixed === "left") {
       bi -= i;
-    } else if (b.fixed === "right" || b.hideInSetting && !b.fixed) {
+    } else if (b.fixed === "right" || isHideInCol(b) && !b.fixed) {
       bi += i;
     }
     return ai - bi;
   });
   return data;
 }
-function getColItems(columns, untitledText, indexText, expandText, filter, sortFixed, cancelFixed) {
+function getColItems(columns, locale, filter, cacheCols, sortFixed, cancelFixed) {
   const temp = columns == null ? [] : [...columns];
   if (sortFixed) {
-    temp.sort((a, b) => {
-      return getColFixedNumber(a.fixed) - getColFixedNumber(b.fixed);
-    });
+    temp.sort(
+      (a, b) => getColFixedNumber(a.fixed) - getColFixedNumber(b.fixed)
+    );
   }
-  return mapTree(temp, (d, _i, parent) => {
+  const cols = mapTree(temp, (d, _i, parent) => {
     const colId = getColId(d);
     if (colId == null || filter && !filter(d)) {
       return;
     }
-    return {
+    const old = findTree(cacheCols, (t) => t.uid === colId);
+    const item = {
       uid: colId,
-      //prop: d.prop,
-      //columnKey: d.columnKey,
-      label: d.label || (d.type === "index" ? indexText : d.type === "expand" ? expandText : untitledText),
-      checked: !d.hideInTable,
-      fixed: cancelFixed ? false : parent == null ? d.fixed : false,
-      type: d.type
+      type: d.type,
+      label: d.label || (d.type === "index" ? locale.columnIndex : d.type === "expand" ? locale.columnExpand : locale.columnUntitled),
+      checked: (old == null ? void 0 : old.checked) ?? !d.hideInTable,
+      fixed: cancelFixed || parent != null ? false : (old == null ? void 0 : old.fixed) ?? d.fixed
     };
+    return item;
   });
-}
-function getSettingCols(columns, untitledText, cacheKey) {
-  const cacheResult = getCacheCols(cacheKey);
-  if (cacheResult) {
-    return cacheResult;
+  if (cacheCols && cacheCols.length) {
+    cols.sort((a, b) => {
+      const oldAI = cacheCols.findIndex((t) => t.uid === a.uid);
+      const oldBI = cacheCols.findIndex((t) => t.uid === b.uid);
+      const ai = oldAI === -1 ? cols.indexOf(a) : oldAI;
+      const bi = oldBI === -1 ? cols.indexOf(b) : oldBI;
+      return ai - bi;
+    });
+    eachTree(cols, (item) => {
+      var _a;
+      if (item.children && item.children.length) {
+        const oldC = (_a = findTree(cacheCols, (t) => t.uid === item.uid)) == null ? void 0 : _a.children;
+        if (oldC && oldC.length) {
+          item.children.sort((a, b) => {
+            const oldAI = oldC.findIndex((t) => t.uid === a.uid);
+            const oldBI = oldC.findIndex((t) => t.uid === b.uid);
+            const ai = oldAI === -1 ? cols.indexOf(a) : oldAI;
+            const bi = oldBI === -1 ? cols.indexOf(b) : oldBI;
+            return ai - bi;
+          });
+        }
+      }
+    });
   }
-  const excludes = ["selection", "index", "expand"];
-  return mapTree(columns, (d) => {
-    const colId = getColId(d);
-    if (colId && !d.hideInSetting && !(d.type && excludes.includes(d.type))) {
-      return {
-        uid: colId,
-        prop: d.prop,
-        columnKey: d.columnKey,
-        label: d.label || untitledText,
-        checked: !d.hideInTable,
-        fixed: d.fixed
-      };
+  let checkAll = true;
+  let indeterminate = false;
+  eachTree(cols, (d) => {
+    if (!d.checked && checkAll) {
+      checkAll = false;
+    }
+    if (d.checked && !indeterminate) {
+      indeterminate = true;
+    }
+    if (!checkAll && indeterminate) {
+      return false;
     }
   });
+  return {
+    cols,
+    checkAll: cols.length > 0 && checkAll,
+    indeterminate: !checkAll && indeterminate
+  };
 }
 function getCacheCols(cacheKey) {
   if (cacheKey) {
-    const temp = localStorage.getItem(getColsCacheKey(cacheKey));
-    if (temp) {
+    const oldJSON = localStorage.getItem(getColsCacheKey(cacheKey));
+    if (oldJSON) {
       try {
-        const data = JSON.parse(temp);
-        if (data && Array.isArray(data)) {
-          data.forEach((d) => {
-            if (d.uid == null && d.id != null) {
-              d.uid = d.id;
-            }
-          });
-          return data;
-        }
+        const old = JSON.parse(oldJSON);
+        return old && Array.isArray(old) ? old : void 0;
       } catch (e) {
         console.error(e);
       }
@@ -630,9 +655,16 @@ function columnsPrintFilter(item) {
   }
   return !item.type || !["selection"].includes(item.type);
 }
+function columnsSettingFilter(item) {
+  if (item.hideInSetting) {
+    return false;
+  }
+  return !item.type || !["selection", "index", "expand"].includes(item.type);
+}
 export {
   columnsExportFilter,
   columnsPrintFilter,
+  columnsSettingFilter,
   exportCSV,
   getCacheCols,
   getCacheSize,
@@ -657,7 +689,6 @@ export {
   getResponseName,
   getResponseResult,
   getRowKey,
-  getSettingCols,
   getSizeCacheKey,
   getTableLimit,
   getTablePage,