vxe-table 3.7.0-beta.1 → 3.7.0-beta.11

package/types/column.d.ts

@@ -8,6 +8,8 @@ import { ColumnEditRenderOptions, ColumnEditSlotParams } from './edit'
 import { ColumnExportCellRenderParams, ColumnExportFooterRenderParams, ColumnExportHeaderRenderParams } from './export'
 import { TableOverflow } from './table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 列
  */
@@ -356,6 +358,7 @@ export class ColumnInfo {
     update: boolean;
     value: any;
   };
+
   children: ColumnInfo[];
 
   getTitle(): string;

package/types/edit.d.ts

@@ -1,17 +1,19 @@
 import { VXETableComponent } from './component'
 import { ColumnCellRenderParams, RenderOptions, OptionProps, OptionGroupProps } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 编辑
  */
 export declare class Edit extends VXETableComponent {}
 
-export interface ColumnEditSlotParams extends ColumnEditRenderParams {}
+export type ColumnEditSlotParams = ColumnEditRenderParams
 
 /**
  * 单元格编辑渲染参数
  */
-export interface ColumnEditRenderParams extends ColumnCellRenderParams {}
+export type ColumnEditRenderParams = ColumnCellRenderParams
 
 /**
  * 编辑渲染配置项

package/types/export.d.ts

@@ -4,6 +4,8 @@ import { Grid } from './grid'
 import { ColumnInfo } from './column'
 import { GridRenderParams } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 导出
  */
@@ -231,6 +233,7 @@ export interface ColumnExportCellRenderParams extends GridRenderParams {
 
 export interface ColumnExportHeaderRenderParams extends GridRenderParams {
   column: ColumnInfo;
+  options: ExportParams;
 }
 
 export interface ColumnExportFooterRenderParams extends GridRenderParams {

package/types/filter.d.ts

@@ -2,6 +2,8 @@ import { VXETableComponent } from './component'
 import { ColumnInfo } from './column'
 import { TableRenderParams, RenderOptions, OptionProps, OptionGroupProps } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 筛选
  */
@@ -92,7 +94,7 @@ export interface ColumnFilterMethodParams {
   column: ColumnInfo;
 }
 
-export interface ColumnFilterSlotParams extends ColumnFilterRenderParams {}
+export type ColumnFilterSlotParams = ColumnFilterRenderParams
 
 export interface ColumnFilterResetParams extends TableRenderParams {
   options: ColumnFilterParams[];

package/types/footer.d.ts

@@ -2,12 +2,14 @@ import { VXETableComponent } from './component'
 import { ColumnInfo } from './column'
 import { TableRenderParams } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 表尾
  */
 export declare class Footer extends VXETableComponent {}
 
-export interface ColumnFooterSlotParams extends ColumnFooterRenderParams {}
+export type ColumnFooterSlotParams = ColumnFooterRenderParams
 
 /**
  * 表尾渲染参数

package/types/form-item.d.ts

@@ -2,6 +2,8 @@ import { VXETableComponent } from './component'
 import { Form } from './form'
 import { RenderParams, RenderOptions, OptionProps, OptionGroupProps } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 表单 - 项
  */

package/types/form.d.ts

@@ -1,6 +1,8 @@
 import { VXETableComponent } from './component'
 import { FormItemOptions } from './form-item'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 表单
  */
@@ -81,18 +83,7 @@ export interface FormRule {
    * 使用自定义校验函数，接收一个 Promise
    * @param params 参数
    */
-  validator?(params: {
-    $form: Form,
-    itemValue: any,
-    rule: FormRule;
-    rules: FormRule[];
-    data: any;
-    field: string
-    /**
-     * @deprecated
-     */
-    property: string
-  }): void | Error | Promise<any>
+  validator?(params: FormRuleValidatorParams): void | Error | Promise<any>
   /**
    * 提示消息
    */
@@ -101,6 +92,19 @@ export interface FormRule {
   maxWidth?: number;
 }
 
+export interface FormRuleValidatorParams {
+  $form: Form,
+  itemValue: any,
+  rule: FormRule;
+  rules: FormRule[];
+  data: any;
+  field: string
+  /**
+   * @deprecated
+   */
+  property: string
+}
+
 /**
  * 校验规则配置项
  */

package/types/grid.d.ts

@@ -7,6 +7,8 @@ import { ToolbarOptions } from './toolbar'
 import { PagerOptions } from './pager'
 import { RowInfo } from './component'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 高级表格
  */
@@ -74,6 +76,7 @@ export declare class Grid extends Table {
     pager: any;
     pendingRecords: any[];
   };
+
   [key: string]: any;
 }
 

package/types/header.d.ts

@@ -2,12 +2,14 @@ import { VXETableComponent } from './component'
 import { ColumnInfo } from './column'
 import { TableRenderParams } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 表头
  */
 export declare class Header extends VXETableComponent {}
 
-export interface ColumnHeaderSlotParams extends ColumnHeaderRenderParams {}
+export type ColumnHeaderSlotParams = ColumnHeaderRenderParams
 
 /**
  * 表头渲染参数

package/types/index.d.ts

@@ -1,7 +1,7 @@
 import * as VXETableExport from './all'
 
 /**
- * 一个基于 vue 的 PC 端表格组件，支持增删改查、虚拟列表、虚拟树、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、弹窗、自定义模板、渲染器、贼灵活的配置项、扩展接口等...  
+ * 一个基于 vue 的 PC 端表格组件，支持增删改查、虚拟列表、虚拟树、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、弹窗、自定义模板、渲染器、贼灵活的配置项、扩展接口等...
  */
 declare const VXETable: typeof VXETableExport
 

package/types/input.d.ts

@@ -1,5 +1,7 @@
 import { VXETableComponent } from './component'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 输入框
  */

package/types/list.d.ts

@@ -62,7 +62,7 @@ export declare class List extends VXETableComponent {
    * 刷新滚动操作，手动同步滚动相关位置
    */
   refreshScroll(): Promise<any>;
-  
+
   /**
    * 手动清除滚动相关信息，还原到初始状态
    */

package/types/menu.d.ts

@@ -1,6 +1,8 @@
 import { VXETableComponent } from './component'
 import { ColumnCellRenderParams } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 快捷菜单
  */

package/types/modal.d.ts

@@ -1,6 +1,8 @@
 import { CreateElement, VNode } from 'vue'
 import { VXETableComponent } from './component'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 弹窗
  */
@@ -40,6 +42,7 @@ export declare class Modal extends VXETableComponent {
     top?: number;
     left?: number;
   };
+
   /**
    * 窗口的标题
    */
@@ -157,6 +160,7 @@ export declare class Modal extends VXETableComponent {
     top?: number;
     left?: number;
   } | null;
+
   /**
    * 设置窗口位置
    */
@@ -257,9 +261,9 @@ export interface ModalDefaultSlotParams {
   $modal: Modal;
 }
 
-export interface ModalHeaderSlotParams extends ModalDefaultSlotParams {}
-export interface ModalTitleSlotParams extends ModalDefaultSlotParams {}
-export interface ModalFooterSlotParams extends ModalDefaultSlotParams {}
+export type ModalHeaderSlotParams = ModalDefaultSlotParams
+export type ModalTitleSlotParams = ModalDefaultSlotParams
+export type ModalFooterSlotParams = ModalDefaultSlotParams
 
 export interface ModalEventParams {
   $modal: Modal;

package/types/pulldown.d.ts

@@ -30,15 +30,14 @@ export declare class Pulldown extends VXETableComponent {
    * 切换下拉面板
    */
   togglePanel(): Promise<any>;
-  
+
   /**
    * 显示下拉面板
    */
   showPanel(): Promise<any>;
-  
+
   /**
    * 隐藏下拉面板
    */
   hidePanel(): Promise<any>;
-
 }

package/types/table.d.ts

@@ -7,6 +7,8 @@ import { ColumnEditRule, ColumnEditValidErrMapParams } from './validator'
 import { ColumnFooterRenderParams } from './footer'
 import { MenuOptions, MenuFirstOption } from './menu'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 表格
  */
@@ -23,6 +25,10 @@ export declare class Table extends VXETableComponent {
    * 表格的高度
    */
   height?: number | string;
+  /**
+   * 表格的最小高度
+   */
+  minHeight?: number | string;
   /**
    * 表格的最大高度
    */
@@ -95,51 +101,51 @@ export declare class Table extends VXETableComponent {
   /**
    * 给行附加 className
    */
-  rowClassName?: string | Function;
+  rowClassName?: string | ((params: any) => any);
   /**
    * 给单元格附加 className
    */
-  cellClassName?: string | Function;
+  cellClassName?: string | ((params: any) => any);
   /**
    * 给表头的行附加 className
    */
-  headerRowClassName?: string | Function;
+  headerRowClassName?: string | ((params: any) => any);
   /**
    * 给表头的单元格附加 className
    */
-  headerCellClassName?: string | Function;
+  headerCellClassName?: string | ((params: any) => any);
   /**
    * 给表尾的行附加 className
    */
-  footerRowClassName?: string | Function;
+  footerRowClassName?: string | ((params: any) => any);
   /**
    * 给表尾的单元格附加 className
    */
-  footerCellClassName?: string | Function;
+  footerCellClassName?: string | ((params: any) => any);
   /**
    * 给单元格附加样式
    */
-  cellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
+  cellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
   /**
    * 给表头单元格附加样式
    */
-  headerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
+  headerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
   /**
    * 给表尾单元格附加样式
    */
-  footerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
+  footerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
   /**
    * 给行附加样式
    */
-  rowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
+  rowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
   /**
    * 给表头行附加样式
    */
-  headerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
+  headerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
   /**
    * 给表尾行附加样式
    */
-  footerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
+  footerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
   /**
    * 临时合并单元格
    */
@@ -496,6 +502,7 @@ export declare class Table extends VXETableComponent {
     fixed?: boolean
     order?: boolean
    }): Promise<any>;
+
   /**
    * 刷新列配置
    * 对于动态修改属性、显示/隐藏列等场景下可能会用到
@@ -1161,18 +1168,18 @@ export interface TableOptions {
   highlightCell?: boolean;
   showFooter?: boolean;
   footerMethod?: typeof TableFooterMethod;
-  rowClassName?: string | Function;
-  cellClassName?: string | Function;
-  headerRowClassName?: string | Function;
-  headerCellClassName?: string | Function;
-  footerRowClassName?: string | Function;
-  footerCellClassName?: string | Function;
-  cellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
-  headerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
-  footerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
-  rowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
-  headerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
-  footerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
+  rowClassName?: string | ((params: any) => any);
+  cellClassName?: string | ((params: any) => any);
+  headerRowClassName?: string | ((params: any) => any);
+  headerCellClassName?: string | ((params: any) => any);
+  footerRowClassName?: string | ((params: any) => any);
+  footerCellClassName?: string | ((params: any) => any);
+  cellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
+  headerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
+  footerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
+  rowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
+  headerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
+  footerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | ((params: any) => any);
   mergeCells?: TableMergeConfig[];
   mergeFooterItems?: TableMergeConfig[];
   spanMethod?: typeof TableSpanMethod;
@@ -1250,6 +1257,7 @@ export interface TableColumnConfig {
   width?: number
   minWidth?: number
   maxWidth?: number
+  headerExportMethod?(params: any): string | number
 }
 export type ColumnDefaultConfig = TableColumnConfig
 
@@ -1276,13 +1284,13 @@ export interface TableSeqConfig {
 }
 export type SeqConfig = TableSeqConfig
 
+export type TableSortOrder = 'asc' | 'desc' | '' | null;
+
 export interface TableSortConfs {
   field: string;
   order?: TableSortOrder;
 }
 
-export type TableSortOrder = 'asc' | 'desc' | '' | null;
-
 /**
  * 排序配置项
  */
@@ -1382,26 +1390,41 @@ export type ExpandConfig = TableExpandConfig
  * 树形结构配置项
  */
 export interface TableTreeConfig {
-  children?: string;
+  childrenField?: string;
   indent?: number;
-  line?: boolean;
+  showLine?: boolean;
   expandAll?: boolean;
   expandRowKeys?: string[] | number[];
   accordion?: boolean;
   trigger?: 'default' | 'cell' | 'row' | '';
   lazy?: boolean;
-  hasChild?: string;
+  hasChildField?: string;
   loadMethod?(params: { row: RowInfo }): Promise<any[]>;
   toggleMethod?(params: { expanded: boolean, row: RowInfo, column: ColumnInfo, columnIndex: number, $columnIndex: number }): boolean;
   showIcon?: boolean;
   iconOpen?: string;
   iconClose?: string;
   iconLoaded?: string;
+  /**
+   * 已废弃，请使用 showLine
+   * @deprecated
+   */
+  line?: boolean;
+  /**
+   * 已废弃，请使用 hasChildField
+   * @deprecated
+   */
+  hasChild: string;
+  /**
+   * 已废弃，请使用 childrenField
+   * @deprecated
+   */
+  children?: string
 }
 export type TreeConfig = TableTreeConfig
 
 export interface TreeOpts {
-  children: string;
+  childrenField: string;
   indent: number;
   line?: boolean;
   expandAll?: boolean;
@@ -1410,6 +1433,7 @@ export interface TreeOpts {
   trigger?: 'default' | 'cell' | 'row' | '';
   lazy?: boolean;
   hasChild: string;
+  hasChildField: string;
   loadMethod?(params: { row: RowInfo }): Promise<any[]>;
   toggleMethod?(params: { expanded: boolean, row: RowInfo, column: ColumnInfo, columnIndex: number, $columnIndex: number }): boolean;
   showIcon: boolean;

package/types/textarea.d.ts

@@ -43,6 +43,7 @@ export declare class Textarea extends VXETableComponent {
     minRows?: number;
     maxRows?: number;
   };
+
   /**
    * 原生 form 属性
    */

package/types/toolbar.d.ts

@@ -3,6 +3,8 @@ import { VXETableComponent } from './component'
 import { ColumnInfo } from './column'
 import { GridRenderParams, RenderOptions } from './v-x-e-table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 工具栏
  */

package/types/tooltip.d.ts

@@ -19,7 +19,7 @@ export declare class Tooltip extends VXETableComponent {
   /**
    * 显示内容
    */
-  content?: string | Function;
+  content?: string | ((params: any) => any);
   /**
    * 自定义堆叠顺序
    */

package/types/v-x-e-table/commands.d.ts

@@ -1,19 +1,29 @@
 import { ToolbarButtonConfig } from '../toolbar'
-import { GridRenderParams } from './renderer'
+import { Table } from '../table'
 
-declare function commandsFunc(params: CommandsParams, ...args: any[]): any;
+/* eslint-disable no-use-before-define */
 
-/**
- * 全局指令
- */
-export class VxeGlobalCommands {
-  mixin(map: { [type: string]: typeof commandsFunc }): VxeGlobalCommands;
-  get(type: string): typeof commandsFunc;
-  add(type: string, callback: typeof commandsFunc): VxeGlobalCommands;
-  delete(type: string): VxeGlobalCommands;
+export namespace VxeGlobalCommandsHandles {
+  export interface CommandsOptions {
+    commandMethod?: (params: CommandMethodParams, ...args: any[]) => void
+  }
+  export interface CommandMethodParams {
+    $table: Table;
+    code: string;
+    button?: ToolbarButtonConfig;
+  }
 }
 
-export interface CommandsParams extends GridRenderParams {
-  code: string;
-  button?: ToolbarButtonConfig;
+/**
+ * 全局格式化
+ */
+export interface VxeGlobalCommands {
+  mixin(opts: {
+    [name: string]: VxeGlobalCommandsHandles.CommandsOptions | ((params: VxeGlobalCommandsHandles.CommandMethodParams, ...args: any[]) => void)
+  }): VxeGlobalCommands
+  has(name: string): boolean
+  get(name: string): VxeGlobalCommandsHandles.CommandsOptions
+  add(name: string, options: VxeGlobalCommandsHandles.CommandsOptions | ((params: VxeGlobalCommandsHandles.CommandMethodParams, ...args: any[]) => void)): VxeGlobalCommands
+  delete(name: string): void
+  forEach(callback: (options: VxeGlobalCommandsHandles.CommandsOptions, name: string) => void): void
 }

package/types/v-x-e-table/formats.d.ts

@@ -1,19 +1,28 @@
 import { ColumnInfo } from '../column'
 
-declare function formatsFunc(params: FormatsParams, ...args: any[]): any;
+/* eslint-disable no-use-before-define */
+
+export namespace VxeGlobalFormatsHandles {
+  export interface FormatsOptions {
+    cellFormatMethod?: (params: FormatMethodParams, ...args: any[]) => string | number
+  }
+  export interface FormatMethodParams {
+    cellValue: any
+    row: any
+    column: ColumnInfo
+  }
+}
 
 /**
  * 全局格式化
  */
-export class VxeGlobalFormats {
-  mixin(map: { [type: string]: typeof formatsFunc }): VxeGlobalFormats;
-  get(type: string): typeof formatsFunc;
-  add(type: string, callback: typeof formatsFunc): VxeGlobalFormats;
-  delete(type: string): VxeGlobalFormats;
-}
-
-export interface FormatsParams {
-  cellValue: any;
-  row: any,
-  column: ColumnInfo;
+export interface VxeGlobalFormats {
+  mixin(opts: {
+    [name: string]: VxeGlobalFormatsHandles.FormatsOptions | ((params: VxeGlobalFormatsHandles.FormatMethodParams, ...args: any[]) => string | number)
+  }): VxeGlobalFormats
+  has(name: string): boolean
+  get(name: string): VxeGlobalFormatsHandles.FormatsOptions
+  add(name: string, options: VxeGlobalFormatsHandles.FormatsOptions | ((params: VxeGlobalFormatsHandles.FormatMethodParams, ...args: any[]) => string | number)): VxeGlobalFormats
+  delete(name: string): void
+  forEach(callback: (options: VxeGlobalFormatsHandles.FormatsOptions, name: string) => void): void
 }