vxe-table 4.1.21 → 4.2.0-beta.3

package/types/edit.d.ts

@@ -4,14 +4,14 @@ import { VxeTableDefines } from './table'
 /**
  * 表格扩展 - 编辑
  */
-export const Edit: VXEComponent<{}>;
+export const Edit: VXEComponent<{}>
 
 export interface TableEditMethods {
   /**
    * 往表格插入临时数据，从第一行新增一行或多行新数据
    * @param records 新数据
    */
-  insert(records: RecordInfo | RecordInfo[]): Promise<{ row: any, rows: any[] }>;
+  insert(records: RecordInfo | RecordInfo[]): Promise<{ row: any, rows: any[] }>
   /**
    * 往表格指定行中插入临时数据
    * 如果 row 为空则从插入到顶部，如果为树结构，则插入到目标节点顶部
@@ -20,101 +20,101 @@ export interface TableEditMethods {
    * @param {Object/Array} records 新的数据
    * @param {Row} row 指定行
    */
-  insertAt(records: RecordInfo | RecordInfo[], row: any | -1 | null): Promise<{ row: any, rows: any[] }>;
+  insertAt(records: RecordInfo | RecordInfo[], row: any | -1 | null): Promise<{ row: any, rows: any[] }>
   /**
    * 删除指定行数据，指定 row 或 [row, ...] 删除多条数据，如果为空则删除所有数据
    * @param rows 指定行
    */
-  remove(rows?: any | any[]): Promise<{ row: any, rows: any[] }>;
+  remove(rows?: any | any[]): Promise<{ row: any, rows: any[] }>
   /**
    * 删除复选框选中的行数据
    */
-  removeCheckboxRow(): Promise<{ row: any, rows: any[] }>;
+  removeCheckboxRow(): Promise<{ row: any, rows: any[] }>
   /**
    * 删除单选框选中的行数据
    */
-  removeRadioRow(): Promise<{ row: any, rows: any[] }>;
+  removeRadioRow(): Promise<{ row: any, rows: any[] }>
   /**
    * 删除当前行选中的行数据
    */
-  removeCurrentRow(): Promise<{ row: any, rows: any[] }>;
+  removeCurrentRow(): Promise<{ row: any, rows: any[] }>
   /**
    * 获取表格数据集
    * 获取新增、删除、更改的数据
    */
   getRecordset(): {
-    insertRecords: any[];
-    removeRecords: any[];
-    updateRecords: any[];
-  };
+    insertRecords: any[]
+    removeRecords: any[]
+    updateRecords: any[]
+  }
   /**
    * 用于 edit-config，获取新增的临时数据
    */
-  getInsertRecords(): any[];
+  getInsertRecords(): any[]
   /**
    * 获取已删除的数据
    */
-  getRemoveRecords(): any[];
+  getRemoveRecords(): any[]
   /**
    * 用于 edit-config，获取已修改的数据
    */
-  getUpdateRecords(): any[];
+  getUpdateRecords(): any[]
   /**
    * 用于 edit-config，获取已激活的行数据
    */
   getActiveRecord(): {
-    row: any;
-    rowIndex: number;
-    $rowIndex: number;
-    column: VxeTableDefines.ColumnInfo;
-    columnIndex: number;
-    $columnIndex: number;
-    cell: HTMLElement;
-  };
+    row: any
+    rowIndex: number
+    $rowIndex: number
+    column: VxeTableDefines.ColumnInfo
+    columnIndex: number
+    $columnIndex: number
+    cell: HTMLElement
+  }
   /**
    * 用于 mouse-config.selected，获取选中的单元格信息
    */
   getSelectedCell(): {
-    row: any;
-    column: VxeTableDefines.ColumnInfo;
-  };
+    row: any
+    column: VxeTableDefines.ColumnInfo
+  }
   /**
    * 手动清除单元格激活状态
    */
-  clearActived(evnt?: Event): Promise<any>;
+  clearActived(evnt?: Event): Promise<any>
   /**
    * 手动清除单元格选中状态
    */
-  clearSelected(): Promise<any>;
+  clearSelected(): Promise<any>
   /**
    * 用于 edit-config，判断行是否为激活编辑状态
    * @param row 指定行
    */
-  isActiveByRow(row: any): boolean;
+  isActiveByRow(row: any): boolean
   /**
    * 用于 edit-config，激活行编辑并激活第一个单元格
    * @param row 指定行
    */
-  setActiveRow(row: any): Promise<any>;
+  setActiveRow(row: any): Promise<any>
   /**
    * 用于 edit-config，激活单元格编辑
    * @param row 指定行
    * @param field 字段名
    */
-  setActiveCell(row: any, fieldOrColumn: string | VxeTableDefines.ColumnInfo): Promise<any>;
+  setActiveCell(row: any, fieldOrColumn: string | VxeTableDefines.ColumnInfo): Promise<any>
   /**
    * 用于 mouse-config.mouse-config，选中某个单元格
    * @param row 指定行
    * @param field 字段名
    */
-  setSelectCell(row: any, fieldOrColumn: string | VxeTableDefines.ColumnInfo): Promise<any>;
+  setSelectCell(row: any, fieldOrColumn: string | VxeTableDefines.ColumnInfo): Promise<any>
 }
 
 export interface TableEditPrivateMethods {
-  handleActived(params: any, evnt?: any): Promise<any>;
-  handleFocus(params: any, evnt?: any): void;
-  handleSelected(params: any, evnt: any): Promise<any>;
-  addCellSelectedClass(): void;
+  handleActived(params: any, evnt?: any): Promise<any>
+  handleFocus(params: any, evnt?: any): void
+  handleSelected(params: any, evnt: any): Promise<any>
+  addCellSelectedClass(): void
 }
 
 declare module './grid' {

package/types/export.d.ts

@@ -5,55 +5,55 @@ import { VxeGridConstructor } from './grid'
 /**
  * 表格扩展 - 导出、导入、打印
  */
-export const Export: VXEComponent<{}>;
+export const Export: VXEComponent<{}>
 
 export interface TableExportMethods {
   /**
    * 打开高级导出
    * @param options 参数
    */
-  openExport(options?: VxeTablePropTypes.ExportConfig): void;
+  openExport(options?: VxeTablePropTypes.ExportConfig): void
   /**
    * 将表格数据导出
    * @param options 参数
    */
-  exportData(options?: VxeTablePropTypes.ExportConfig): Promise<any>;
+  exportData(options?: VxeTablePropTypes.ExportConfig): Promise<any>
   /**
    * 打开高级导入
    * @param options 参数
    */
-  openImport(options?: VxeTablePropTypes.ImportConfig): void;
+  openImport(options?: VxeTablePropTypes.ImportConfig): void
   /**
    * 将数据导入表格
    * @param options 参数
    */
-  importData(options?: VxeTablePropTypes.ImportConfig): Promise<any>;
+  importData(options?: VxeTablePropTypes.ImportConfig): Promise<any>
   /**
    * 将一个文件的数据导入表格
    * @param file 文件流
    * @param options 参数
    */
-  importByFile(file: File, options: VxeTablePropTypes.ImportConfig): Promise<any>;
+  importByFile(file: File, options: VxeTablePropTypes.ImportConfig): Promise<any>
   /**
    * 保存文件到本地
    * @param options
    */
-  saveFile: SaveFileFunction;
+  saveFile: SaveFileFunction
   /**
    * 读取本地文件
    * @param options 参数
    */
-  readFile: ReadFileFunction;
+  readFile: ReadFileFunction
   /**
    * 打印表格数据
    * @param options 参数
    */
-  print: PrintFunction;
+  print: PrintFunction
   /**
    * 打开高级打印
    * @param options 参数
    */
-  openPrint(options?: VxeTablePropTypes.PrintConfig): void;
+  openPrint(options?: VxeTablePropTypes.PrintConfig): void
 }
 
 export interface TableExportPrivateMethods { }
@@ -67,12 +67,12 @@ declare module './table' {
   interface VxeTablePrivateMethods extends TableExportPrivateMethods { }
   namespace VxeTableDefines {
     interface ExtortSheetMethodParams {
-      $table: VxeTableConstructor;
-      $grid?: VxeGridConstructor;
-      options: VxeTablePropTypes.ExportHandleOptions;
-      datas: any[];
-      columns: VxeTableDefines.ColumnInfo[];
-      colgroups: VxeTableDefines.ColumnInfo[][];
+      $table: VxeTableConstructor
+      $grid?: VxeGridConstructor
+      options: VxeTablePropTypes.ExportHandleOptions
+      datas: any[]
+      columns: VxeTableDefines.ColumnInfo[]
+      colgroups: VxeTableDefines.ColumnInfo[][]
     }
   }
   namespace VxeTablePropTypes {
@@ -83,52 +83,52 @@ declare module './table' {
       /**
        * 可选文件类型列表
        */
-      types?: string[];
+      types?: string[]
       /**
        * 导入数据的方式
        */
-      mode?: string;
-      modes?: string[];
+      mode?: string
+      modes?: string[]
       /**
        * 是否显示内置的消息提示
        */
-      message?: boolean;
+      message?: boolean
       /**
        * 是否服务端导出
        */
-      remote?: boolean;
+      remote?: boolean
       /**
        * 只对 remote=true 有效，用于自定义导入逻辑
        */
       importMethod?(params: {
-        $table: VxeTableConstructor;
-        $grid: VxeGridConstructor;
-        file: File;
-        options: ImportHandleOptions;
-      }): Promise<any>;
+        $table: VxeTableConstructor
+        $grid: VxeGridConstructor
+        file: File
+        options: ImportHandleOptions
+      }): Promise<any>
       beforeImportMethod?(params: {
-        $table: VxeTableConstructor;
-        options: any;
-      }): void;
+        $table: VxeTableConstructor
+        options: any
+      }): void
       afterImportMethod?(params: {
-        $table: VxeTableConstructor;
-        options: any;
-        status: boolean;
-      }): void;
+        $table: VxeTableConstructor
+        options: any
+        status: boolean
+      }): void
     }
     export interface ImportOpts extends ImportConfig {
-      modes: string[];
+      modes: string[]
     }
     export interface ImportHandleOptions extends ImportConfig {
-      data: any[];
-      columns: VxeTableDefines.ColumnInfo[];
-      colgroups: VxeTableDefines.ColumnInfo[][];
+      data: any[]
+      columns: VxeTableDefines.ColumnInfo[]
+      colgroups: VxeTableDefines.ColumnInfo[][]
     }
 
     interface ExportOrPrintColumnOption {
-      colid?: number;
-      type?: string;
-      field?: string;
+      colid?: number
+      type?: string
+      field?: string
     }
 
     /**
@@ -138,98 +138,98 @@ declare module './table' {
       /**
        * 文件名
        */
-      filename?: string;
+      filename?: string
       /**
        * 表名
        */
-      sheetName?: string;
+      sheetName?: string
       /**
        * 文件类型
        */
-      type?: string;
+      type?: string
       /**
        * 可选文件类型列表
        */
-      types?: string[];
+      types?: string[]
       /**
        * 输出数据的方式
        */
-      mode?: string;
+      mode?: string
       /**
        * 输出数据的方式列表
        */
-      modes?: string[];
+      modes?: string[]
       /**
        * 是否为源数据
        */
-      original?: boolean;
+      original?: boolean
       /**
        * 是否显示内置的消息提示
        */
-      message?: boolean;
+      message?: boolean
       /**
        * 是否需要表头
        */
-      isHeader?: boolean;
+      isHeader?: boolean
       /**
        * 是否需要表尾
        */
-      isFooter?: boolean;
-      isMerge?: boolean;
-      isColgroup?: boolean;
+      isFooter?: boolean
+      isMerge?: boolean
+      isColgroup?: boolean
       /**
        * 是否马上下载，如果设置为 false 则通过返回结果为内容的 Promise
        */
-      download?: boolean;
+      download?: boolean
       /**
        * 自定义数据
        */
-      data?: any[];
+      data?: any[]
       /**
        * 自定义列
        */
-      columns?: VxeTableDefines.ColumnInfo[] | ExportOrPrintColumnOption[];
+      columns?: VxeTableDefines.ColumnInfo[] | ExportOrPrintColumnOption[]
       /**
        * 列过滤方法
        */
-      columnFilterMethod?(params: { column: VxeTableDefines.ColumnInfo, $columnIndex: number }): boolean;
+      columnFilterMethod?(params: { column: VxeTableDefines.ColumnInfo, $columnIndex: number }): boolean
       /**
        * 数据过滤方法
        */
-      dataFilterMethod?(params: { row: any, $rowIndex: number }): boolean;
+      dataFilterMethod?(params: { row: any, $rowIndex: number }): boolean
       /**
        * 表尾过滤方法
        */
-      footerFilterMethod?(params: { items: any[], $rowIndex: number }): boolean;
+      footerFilterMethod?(params: { items: any[], $rowIndex: number }): boolean
       /**
        * 是否服务端导出
        */
-      remote?: boolean;
+      remote?: boolean
       /**
        * 只对 remote=html,xlsx 有效，是否使用样式
        */
-      useStyle?: boolean;
-      sheetMethod?(params: VxeTableDefines.ExtortSheetMethodParams): void;
+      useStyle?: boolean
+      sheetMethod?(params: VxeTableDefines.ExtortSheetMethodParams): void
       /**
        * 只对 remote=true 有效，用于自定义导出逻辑
        */
       exportMethod?(params: {
-        $table: VxeTableConstructor;
-        $grid?: VxeGridConstructor;
-        options: ExportHandleOptions;
-      }): Promise<any>;
+        $table: VxeTableConstructor
+        $grid?: VxeGridConstructor
+        options: ExportHandleOptions
+      }): Promise<any>
       beforeExportMethod?(params: {
-        options: ExportHandleOptions;
-      }): void;
+        options: ExportHandleOptions
+      }): void
       afterExportMethod?(params: {
-        options: ExportHandleOptions;
-      }): void;
+        options: ExportHandleOptions
+      }): void
     }
     export interface ExportOpts extends ExportConfig { }
     export interface ExportHandleOptions extends ExportConfig {
-      data: any[];
-      columns: VxeTableDefines.ColumnInfo[];
-      colgroups: VxeTableDefines.ColumnInfo[][];
+      data: any[]
+      columns: VxeTableDefines.ColumnInfo[]
+      colgroups: VxeTableDefines.ColumnInfo[][]
     }
 
     /**
@@ -239,63 +239,63 @@ declare module './table' {
       /**
        * 表名
        */
-      sheetName?: string;
+      sheetName?: string
       /**
        * 输出数据的方式
        */
-      mode?: string;
+      mode?: string
       /**
        * 输出数据的方式列表
        */
-      modes?: string[];
+      modes?: string[]
       /**
        * 是否为源数据
        */
-      original?: boolean;
+      original?: boolean
       /**
        * 是否需要表头
        */
-      isHeader?: boolean;
+      isHeader?: boolean
       /**
        * 是否需要表尾
        */
-      isFooter?: boolean;
+      isFooter?: boolean
       /**
        * 自定义数据
        */
-      data?: any[];
+      data?: any[]
       /**
        * 自定义列
        */
-      columns?: VxeTableDefines.ColumnInfo[] | ExportOrPrintColumnOption[];
+      columns?: VxeTableDefines.ColumnInfo[] | ExportOrPrintColumnOption[]
       /**
        * 打印样式
        */
-      style?: string;
+      style?: string
       /**
        * 自定义打印内容
        */
-      content?: string;
+      content?: string
       /**
        * 列过滤方法
        */
-      columnFilterMethod?(params: { column: VxeTableDefines.ColumnInfo, $columnIndex: number }): boolean;
+      columnFilterMethod?(params: { column: VxeTableDefines.ColumnInfo, $columnIndex: number }): boolean
       /**
        * 数据过滤方法
        */
-      dataFilterMethod?(params: { row: any, $rowIndex: number }): boolean;
+      dataFilterMethod?(params: { row: any, $rowIndex: number }): boolean
       /**
        * 表尾过滤方法
        */
-      footerFilterMethod?(params: { items: any[], $rowIndex: number }): boolean;
+      footerFilterMethod?(params: { items: any[], $rowIndex: number }): boolean
       /**
        * 打印之前的方法，可以通过返回自定义打印的内容
        */
       beforePrintMethod?(params: {
-        $table: VxeTableConstructor | null;
-        content: string;
-        options: PrintHandleOptions;
-      }): string;
+        $table: VxeTableConstructor | null
+        content: string
+        options: PrintHandleOptions
+      }): string
     }
     export interface PrintOpts extends PrintConfig { }
     export interface PrintHandleOptions extends PrintConfig { }
@@ -303,19 +303,19 @@ declare module './table' {
 }
 
 export type SaveFileFunction = (options: {
-  filename: string;
-  type: string;
-  content: string | Blob;
-}) => Promise<any>;
+  filename: string
+  type: string
+  content: string | Blob
+}) => Promise<any>
 
 export type ReadFileFunction = (options?: {
-  multiple?: boolean;
-  types?: string[];
-  message?: boolean;
+  multiple?: boolean
+  types?: string[]
+  message?: boolean
 }) => Promise<{
-  status: boolean;
-  files: FileList;
-  file: File;
-}>;
+  status: boolean
+  files: FileList
+  file: File
+}>
 
-export type PrintFunction = (options?: VxeTablePropTypes.PrintConfig) => any;
+export type PrintFunction = (options?: VxeTablePropTypes.PrintConfig) => any

package/types/filter.d.ts

@@ -5,7 +5,7 @@ import { VxeColumnPropTypes } from './column'
 /**
  * 表格扩展 - 筛选
  */
-export const Filter: VXEComponent<{}>;
+export const Filter: VXEComponent<{}>
 
 export interface VxeFilterPanel {
   /**
@@ -13,22 +13,22 @@ export interface VxeFilterPanel {
    * @param evnt 事件
    * @param checked 是否选中
    */
-  changeAllOption(evnt: Event | null, checked: boolean): void;
+  changeAllOption(evnt: Event | null, checked: boolean): void
   /**
    * 筛选选项发生改变
    * @param evnt 事件
    * @param checked 是否选中
    * @param option 选项对象
    */
-  changeOption(evnt: Event | null, checked: boolean, option: VxeTableDefines.FilterOption): void;
+  changeOption(evnt: Event | null, checked: boolean, option: VxeTableDefines.FilterOption): void
   /**
    * 确认筛选
    */
-  confirmFilter(evnt?: Event): void;
+  confirmFilter(evnt?: Event): void
   /**
    * 重置筛选
    */
-  resetFilter(evnt?: Event): void;
+  resetFilter(evnt?: Event): void
 }
 
 export interface TableFilterMethods {
@@ -36,31 +36,31 @@ export interface TableFilterMethods {
    * 手动弹出筛选
    * @param fieldOrColumn 
    */
-  openFilter(fieldOrColumn: VxeColumnPropTypes.Field | VxeTableDefines.ColumnInfo):Promise<any>;
+  openFilter(fieldOrColumn: VxeColumnPropTypes.Field | VxeTableDefines.ColumnInfo):Promise<any>
   /**
    * 用于 filters，修改筛选列表
    * 在筛选条件更新之后可以调用 updateData 函数处理表格数据
    * @param columnOrField 列对象或字段名
    * @param options 选项列表
    */
-  setFilter(fieldOrColumn: VxeColumnPropTypes.Field | VxeTableDefines.ColumnInfo, options: VxeColumnPropTypes.Filter[]): Promise<any>;
+  setFilter(fieldOrColumn: VxeColumnPropTypes.Field | VxeTableDefines.ColumnInfo, options: VxeColumnPropTypes.Filter[]): Promise<any>
   /**
    * 手动清空筛选条件
    * 如果不传 column 则清空所有筛选条件，数据会恢复成未筛选的状态
    * @param column 字段名
    */
-  clearFilter(column?: VxeColumnPropTypes.Field | VxeTableDefines.ColumnInfo | null): Promise<any>;
+  clearFilter(column?: VxeColumnPropTypes.Field | VxeTableDefines.ColumnInfo | null): Promise<any>
   /**
    * 获取当前筛选的所有列信息
    */
-  getCheckedFilters(): VxeTableDefines.FilterCheckedParams[];
+  getCheckedFilters(): VxeTableDefines.FilterCheckedParams[]
 }
 
 export interface TableFilterPrivateMethods {
-  checkFilterOptions(): void;
-  handleClearFilter(column: any): void;
-  triggerFilterEvent(evnt: any, column: any, params: any): void;
-  confirmFilterEvent(evnt: Event): void;
+  checkFilterOptions(): void
+  handleClearFilter(column: any): void
+  triggerFilterEvent(evnt: any, column: any, params: any): void
+  confirmFilterEvent(evnt: Event): void
 }
 
 declare module './grid' {
@@ -72,12 +72,12 @@ declare module './table' {
   interface VxeTablePrivateMethods extends TableFilterPrivateMethods { }
   namespace VxeTableDefines {
     export interface FilterOption {
-      label: string | number;
-      value: any;
-      data: any;
-      resetValue: any;
-      checked: boolean;
-      _checked: boolean;
+      label: string | number
+      value: any
+      data: any
+      resetValue: any
+      checked: boolean
+      _checked: boolean
     }
   }
 }

package/types/footer.d.ts

@@ -4,4 +4,4 @@ import { VxeTableDefines } from './table'
 /**
  * 表格扩展 - 表尾
  */
-export const Footer: VXEComponent<{}>;
+export const Footer: VXEComponent<{}>

package/types/form-gather.d.ts

@@ -6,15 +6,15 @@ import { VxeFormItemPropTypes } from './form-item'
  * 组件 - 表单项集合
  * @example import { FormGather as VxeFormGather } from 'vxe-table'
  */
-export const FormGather: VXEComponent<VxeFormGatherProps>;
+export const FormGather: VXEComponent<VxeFormGatherProps>
 
 export interface VxeFormGatherProps {
   /**
    * 栅格占据的列数（共 24 分栏）
    */
-  span?: VxeFormItemPropTypes.Span;
+  span?: VxeFormItemPropTypes.Span
   /**
    * 给表单项附加 className
    */
-  className?: VxeFormItemPropTypes.ClassName;
+  className?: VxeFormItemPropTypes.ClassName
 }