ele-admin-plus 1.2.1-beta.1 → 1.2.1-beta.3

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

@@ -229,6 +229,8 @@ export interface ColItem {
   children?: ColItem[];
   /** 列类型 */
   type?: string;
+  /** 列宽 */
+  width?: number | string;
 }
 
 /**
@@ -361,6 +363,8 @@ export interface ExportDataResult {
 export interface BeforeExportParams {
   /** 导出的数据 */
   data: DataItem[];
+  /** 导出的数据来源类型 */
+  dataType: ExportDataType;
   /** 导出的列配置 */
   columns?: Columns;
   /** 导出的表头数据封装 */
@@ -377,6 +381,14 @@ export interface BeforeExportParams {
   hideLoading: () => void;
   /** 关闭弹窗 */
   closeModal: () => void;
+  /** 导出的列配置(含未勾选的列) */
+  tableColumns?: Columns;
+  /** 是否导出表头 */
+  showHeader?: boolean;
+  /** 是否导出表尾 */
+  showFooter?: boolean;
+  /** 是否展示层级序号 */
+  showTreeIndex?: boolean;
 }
 
 /**
@@ -398,6 +410,14 @@ export interface ExportConfig {
   dataType?: ExportDataType;
   /** 默认文件名 */
   fileName?: string;
+  /** 重设导出的列 */
+  columns?: Columns;
+  /** 默认是否导出表头 */
+  showHeader?: boolean;
+  /** 默认是否导出表尾 */
+  showFooter?: boolean;
+  /** 默认是否展示层级序号 */
+  showTreeIndex?: boolean;
 }
 
 /**
@@ -416,6 +436,14 @@ export interface PrintConfig {
   beforePrint?: BeforeExport;
   /** 默认数据类型 */
   dataType?: ExportDataType;
+  /** 重设打印的列 */
+  columns?: Columns;
+  /** 默认是否打印表头 */
+  showHeader?: boolean;
+  /** 默认是否打印表尾 */
+  showFooter?: boolean;
+  /** 默认是否展示层级序号 */
+  showTreeIndex?: boolean;
 }
 
 /**
@@ -432,6 +460,31 @@ export interface TablePrintOptions extends ExportDataResult {
   data: DataItem[];
 }
 
+/**
+ * 导出方法参数
+ */
+export interface TableExportParams {
+  /** 打印的数据 */
+  data?: DataItem[];
+  /** 打印的列 */
+  columns?: Columns;
+  /** 是否打印表头 */
+  showHeader?: boolean;
+  /** 是否打印表尾 */
+  showFooter?: boolean;
+  /** 是否展示层级序号 */
+  showTreeIndex?: boolean;
+  /** 数据的来源类型 */
+  dataType?: ExportDataType;
+  /** 导出的文件名 */
+  fileName?: string;
+}
+
+/**
+ * 缓存的名称
+ */
+export type CacheKey = string | undefined;
+
 /**
  * 国际化
  */
@@ -452,6 +505,7 @@ export interface TableLocale {
   columnExpand: string;
   columnFixedLeft: string;
   columnFixedRight: string;
+  columnWidth: string;
   exportOk: string;
   exportCancel: string;
   exportFileName: string;

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, CacheKey, 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 列数据
@@ -121,8 +121,9 @@ export declare function getColId(column: Column): string | undefined;
 /**
  * 获取初始显示的列数据
  * @param columns 列数据
+ * @param cacheColsWidth 缓存的列宽
  */
-export declare function getInitColumns(columns: Columns): Columns;
+export declare function getInitColumns(columns: Columns, cacheColsWidth?: ColItem[]): Columns;
 /**
  * 获取初始显示的列数据
  * @param columns 列数据
@@ -135,44 +136,86 @@ export declare function getInitCacheColumns(columns: Columns, cacheKey?: string,
  * @param columns 原始列数据
  * @param cols 列配置数据
  * @param sortable 是否进行排序
+ * @param isHideInCol 用于排序时计算不显示在配置中的列
+ * @param filter 强制过滤的列
+ * @param reserveUnchecked 是否保留未选中的列
+ * @param cacheColsWidth 缓存的列宽
  */
-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, cacheColsWidth?: ColItem[]): Columns;
 /**
  * 获取列展示列表数据
  * @param columns 列配置
- * @param untitledText 未命名列文字
- * @param indexText 序号列文字
- * @param expandText 展开列文字
+ * @param locale 国际化
  * @param filter 过滤列的方法
+ * @param cacheCols 缓存的列展示列表数据
  * @param sortFixed 是否对固定列排序
  * @param cancelFixed 是否取消固定列
+ * @param cacheColsWidth 缓存的列宽
  */
-export declare function getColItems(columns?: Columns, untitledText?: string, indexText?: string, expandText?: string, filter?: (item: Column) => boolean, sortFixed?: boolean, cancelFixed?: boolean): ColItem[];
+export declare function getColItems(columns: Columns | undefined, locale: TableLocale, filter?: (item: Column) => boolean, cacheCols?: ColItem[], sortFixed?: boolean, cancelFixed?: boolean, cacheColsWidth?: ColItem[]): {
+    cols: ColItem[];
+    checkAll: boolean;
+    indeterminate: boolean;
+};
 /**
- * 获取列配置
- * @param columns 列数据
- * @param untitledText 未命名列文字
+ * 获取表格密度缓存的名称
  * @param cacheKey 缓存的名称
  */
-export declare function getSettingCols(columns?: Columns, untitledText?: string, cacheKey?: string): ColItem[];
+export declare function getSizeCacheKey(cacheKey: string): string;
 /**
- * 获取缓存的列配置下拉列表数据
+ * 获取列配置缓存的名称
  * @param cacheKey 缓存的名称
  */
-export declare function getCacheCols(cacheKey?: string): ColItem[] | undefined;
+export declare function getColsCacheKey<T extends CacheKey>(cacheKey: T): T;
 /**
- * 获取列配置缓存的名称
+ * 获取表格列宽缓存的名称
+ * @param cacheKey 缓存的名称
  */
-export declare function getColsCacheKey(cacheKey: string): string;
+export declare function getColsWidthCacheKey(cacheKey: string): string;
 /**
- * 获取表格密度缓存的名称
+ * 获取导出的列配置缓存的名称
+ * @param cacheKey 缓存的名称
  */
-export declare function getSizeCacheKey(cacheKey: string): string;
+/**
+ * 获取导出的列宽缓存的名称
+ * @param cacheKey 缓存的名称
+ */
+/**
+ * 获取打印的列配置缓存的名称
+ * @param cacheKey 缓存的名称
+ */
+/**
+ * 获取打印的列宽缓存的名称
+ * @param cacheKey 缓存的名称
+ */
+/**
+ * 获取缓存的列配置下拉列表数据
+ * @param cacheKey 缓存的名称
+ */
+export declare function getCacheCols(cacheKey?: string): ColItem[] | undefined;
 /**
  * 获取缓存的表格密度
  * @param cacheKey 缓存的名称
  */
 export declare function getCacheSize(cacheKey?: string): TableSize;
+/**
+ * 获取缓存的列宽
+ * @param cacheKey 缓存的名称
+ */
+export declare function getCacheColsWidth(cacheKey?: string): ColItem[] | undefined;
+/**
+ * 获取列对应的缓存的列宽
+ * @param cacheColsWidth 缓存的列宽
+ * @param column 列配置
+ */
+export declare function getCacheColWidth(cacheColsWidth?: ColItem[], column?: Column): number | string | undefined;
+/**
+ * 缓存列宽
+ * @param width 列宽
+ * @param column 列配置
+ * @param cacheKey 缓存的名称
+ */
+export declare function cacheColWidth(width: number, column?: Column, cacheKey?: string): void;
 /**
  * 获取 rowKey
  * @param rowKey 自定义 rowKey
@@ -214,13 +257,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 +278,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;