vxe-table 4.3.13 → 4.4.0-beta.0

package/types/toolbar.d.ts

@@ -43,7 +43,7 @@ export namespace VxeToolbarPropTypes {
   export interface ResizableOpts extends ResizableConfig { }
 
   interface RefreshConfig {
-    queryMethod?(params: { [key: string]: any }): Promise<any>
+    queryMethod?(params: { [key: string]: any }): any
     code?: 'query' | 'reload' | '' | null
     icon?: string
     iconLoading?: string

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

@@ -1,17 +1,17 @@
-import { VxeTableConstructor, VxeTableDefines } from '../table'
+import { VxeTableConstructor, VxeTableDefines, VxeTableDataRow } from '../table'
 import { VxeGridConstructor } from '../grid'
 import { VxeGlobalRendererHandles } from './renderer'
 
 /* eslint-disable no-use-before-define */
 
 export namespace VxeGlobalMenusHandles {
-  export type MenusCallback = (params: MenusCallbackParams, event: Event) => any
+  export type MenusCallback<D = VxeTableDataRow> = (params: MenusCallbackParams<D>, event: Event) => any
 
-  interface MenusParams {
-    $grid: VxeGridConstructor | null
-    $table: VxeTableConstructor
+  interface MenusParams<D = VxeTableDataRow> {
+    $grid: VxeGridConstructor<D> | null
+    $table: VxeTableConstructor<D>
   }
-  export interface MenusCallbackParams extends MenusParams, VxeGlobalRendererHandles.RenderCellParams {
+  export interface MenusCallbackParams<D = VxeTableDataRow> extends MenusParams<D>, VxeGlobalRendererHandles.RenderCellParams<D> {
     $event: MouseEvent
     menu: VxeTableDefines.MenuFirstOption | VxeTableDefines.MenuChildOption
   }
@@ -22,11 +22,11 @@ export namespace VxeGlobalMenusHandles {
  */
 export interface VxeGlobalMenus {
   mixin(options: {
-    [code: string]: VxeGlobalMenusHandles.MenusCallback
+    [code: string]: VxeGlobalMenusHandles.MenusCallback<any>
   }): VxeGlobalMenus
   has(code: string): boolean
-  get(code: string): VxeGlobalMenusHandles.MenusCallback
-  add(code: string, callback: VxeGlobalMenusHandles.MenusCallback): VxeGlobalMenus
+  get(code: string): VxeGlobalMenusHandles.MenusCallback<any>
+  add(code: string, callback: VxeGlobalMenusHandles.MenusCallback<any>): VxeGlobalMenus
   delete(code: string): void
-  forEach(callback: (options: VxeGlobalMenusHandles.MenusCallback, code: string) => void): void
+  forEach(callback: (options: VxeGlobalMenusHandles.MenusCallback<any>, code: string) => void): void
 }

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

@@ -1,5 +1,5 @@
-import { SlotVNodeType } from '../component'
-import { VxeTableDefines, VxeTableConstructor, VxeTablePropTypes } from '../table'
+import { SlotVNodeType, VNodeStyle } from '../component'
+import { VxeTableDefines, VxeTableConstructor, VxeTablePropTypes, VxeTableDataRow } from '../table'
 import { VxeGridConstructor } from '../grid'
 import { VxeColumnPropTypes } from '../column'
 import { VxeFilterPanel } from '../filter'
@@ -11,8 +11,12 @@ import { FormItemRenderOptions, FormItemTitleRenderParams, FormItemContentRender
 type RendererOptions = DefineRendererOption<VxeGlobalRendererHandles.RenderResult>
 
 export interface DefineRendererOption<T> {
-  // 筛选渲染
+  /**
+   * @deprecated 已废弃
+   */
   className?: string
+
+  // 筛选渲染
   filterClassName?: string | ((params: VxeGlobalRendererHandles.RenderFilterParams) => string | { [key: string]: boolean })
   showFilterFooter?: boolean
   renderFilter?(renderOpts: VxeGlobalRendererHandles.RenderFilterOptions, params: VxeGlobalRendererHandles.RenderFilterParams): T
@@ -25,6 +29,7 @@ export interface DefineRendererOption<T> {
 
   // 单元格渲染
   cellClassName?: string | ((params: VxeGlobalRendererHandles.RenderDefaultParams) => string | { [key: string]: boolean })
+  cellStyle?: string | VNodeStyle | ((params: VxeGlobalRendererHandles.RenderDefaultParams) => string | VNodeStyle)
   renderHeader?(renderOpts: VxeGlobalRendererHandles.RenderHeaderOptions, params: VxeGlobalRendererHandles.RenderHeaderParams): T
   renderDefault?(renderOpts: VxeGlobalRendererHandles.RenderDefaultOptions, params: VxeGlobalRendererHandles.RenderDefaultParams): T
   renderFooter?(renderOpts: VxeGlobalRendererHandles.RenderFooterOptions, params: VxeGlobalRendererHandles.RenderFooterParams): T
@@ -32,10 +37,10 @@ export interface DefineRendererOption<T> {
   footerExportMethod?(params: VxeGlobalRendererHandles.FooterExportMethodParams): string
 
   // 编辑渲染
-  autofocus?: string | ((params: VxeGlobalRendererHandles.RenderEditParams | VxeGlobalRendererHandles.RenderCellParams) => HTMLElement | null)
+  autofocus?: string | ((params: VxeGlobalRendererHandles.RenderEditParams | VxeGlobalRendererHandles.RenderCellParams<any>) => HTMLElement | null)
   autoselect?: boolean
   renderEdit?(renderOpts: VxeGlobalRendererHandles.RenderEditOptions, params: VxeGlobalRendererHandles.RenderEditParams): T
-  renderCell?(renderOpts: VxeGlobalRendererHandles.RenderCellOptions, params: VxeGlobalRendererHandles.RenderCellParams): T
+  renderCell?(renderOpts: VxeGlobalRendererHandles.RenderCellOptions, params: VxeGlobalRendererHandles.RenderCellParams<any>): T
 
   // 内容渲染
   renderExpand?(renderOpts: VxeGlobalRendererHandles.RenderExpandOptions, params: VxeGlobalRendererHandles.RenderExpandParams): T
@@ -46,6 +51,9 @@ export interface DefineRendererOption<T> {
 
   // 表单-项渲染
   itemClassName?: string | ((params: VxeGlobalRendererHandles.RenderItemTitleParams) => string | { [key: string]: boolean })
+  itemStyle?: string | VNodeStyle | ((params: VxeGlobalRendererHandles.RenderItemTitleParams) => string | VNodeStyle)
+  itemContentClassName?: string | ((params: VxeGlobalRendererHandles.RenderItemTitleParams) => string | { [key: string]: boolean })
+  itemContentStyle?: string | VNodeStyle | ((params: VxeGlobalRendererHandles.RenderItemTitleParams) => string | VNodeStyle)
   renderItemTitle?(renderOpts: VxeGlobalRendererHandles.RenderItemTitleOptions, params: VxeGlobalRendererHandles.RenderItemTitleParams): T
   renderItemContent?(renderOpts: VxeGlobalRendererHandles.RenderItemContentOptions, params: VxeGlobalRendererHandles.RenderItemContentParams): T
   itemVisibleMethod?(params: VxeGlobalRendererHandles.ItemVisibleMethodParams): boolean
@@ -62,91 +70,91 @@ export namespace VxeGlobalRendererHandles {
 
   export interface RenderParams {}
 
-  export type RenderFilterParams = {
-    $table: VxeTableConstructor
+  export type RenderFilterParams<D = VxeTableDataRow> = {
+    $table: VxeTableConstructor<D>
     $panel: VxeFilterPanel
     column: {
       filters: VxeTableDefines.FilterOption[]
-    } & VxeTableDefines.ColumnInfo
+    } & VxeTableDefines.ColumnInfo<D>
     columnIndex: number
     $columnIndex: number
     $rowIndex: number
   }
 
-  export type FilterMethodParams = {
-    $table: VxeTableConstructor
+  export type FilterMethodParams<D = VxeTableDataRow> = {
+    $table: VxeTableConstructor<D>
     value: any
     option: VxeTableDefines.FilterOption
     cellValue: any
     row: any
-    column: VxeTableDefines.ColumnInfo
+    column: VxeTableDefines.ColumnInfo<D>
   }
 
-  export interface FilterRemoteMethod extends VxeTableDefines.FilterChangeParams {
-    $table: VxeTableConstructor
+  export interface FilterRemoteMethod<D = VxeTableDataRow> extends VxeTableDefines.FilterChangeParams<D> {
+    $table: VxeTableConstructor<D>
   }
 
-  export interface FilterResetMethodParams {
-    $table: VxeTableConstructor
+  export interface FilterResetMethodParams<D = VxeTableDataRow> {
+    $table: VxeTableConstructor<D>
     options: VxeTableDefines.FilterOption[]
-    column: VxeTableDefines.ColumnInfo
+    column: VxeTableDefines.ColumnInfo<D>
   }
 
-  export interface FilterRecoverMethodParams {
-    $table: VxeTableConstructor
+  export interface FilterRecoverMethodParams<D = VxeTableDataRow> {
+    $table: VxeTableConstructor<D>
     option: VxeTableDefines.FilterOption
-    column: VxeTableDefines.ColumnInfo
+    column: VxeTableDefines.ColumnInfo<D>
   }
 
   export interface RenderHeaderOptions extends VxeGlobalRendererHandles.RenderOptions { }
 
-  export interface RenderHeaderParams {
-    $table: VxeTableConstructor
-    column: VxeTableDefines.ColumnInfo
+  export interface RenderHeaderParams<D = VxeTableDataRow> {
+    $table: VxeTableConstructor<D>
+    column: VxeTableDefines.ColumnInfo<D>
     columnIndex: number
     $columnIndex: number
     $rowIndex: number
   }
 
-  export type RenderDefaultOptions = VxeColumnPropTypes.EditRender
+  export type RenderDefaultOptions<D = VxeTableDataRow> = VxeColumnPropTypes.EditRender<D>
   export type RenderDefaultParams = RenderEditParams
 
   export interface RenderFooterOptions extends VxeGlobalRendererHandles.RenderOptions { }
 
-  export interface RenderFooterParams {
-    $table: VxeTableConstructor
-    column: VxeTableDefines.ColumnInfo
+  export interface RenderFooterParams<D = VxeTableDataRow> {
+    $table: VxeTableConstructor<D>
+    column: VxeTableDefines.ColumnInfo<D>
     columnIndex: number
     _columnIndex: number
     $columnIndex: number
     $rowIndex: number
     items: any[]
-    data: any[][]
+    data: D[][]
   }
 
-  export interface ExportMethodParams {
-    row: any
-    column: VxeTableDefines.ColumnInfo
+  export interface ExportMethodParams<D = VxeTableDataRow> {
+    row: D
+    column: VxeTableDefines.ColumnInfo<D>
     options: VxeTablePropTypes.ExportHandleOptions
   }
 
-  export interface FooterExportMethodParams {
+  export interface FooterExportMethodParams<D = VxeTableDataRow> {
     items: any[]
     _columnIndex: number
-    column: VxeTableDefines.ColumnInfo
+    column: VxeTableDefines.ColumnInfo<D>
     options: VxeTablePropTypes.ExportHandleOptions
   }
 
   export type RenderEditOptions = VxeColumnPropTypes.EditRender
 
-  export interface RenderEditParams {
-    $table: VxeTableConstructor
-    $grid: VxeGridConstructor | null
-    column: VxeTableDefines.ColumnInfo
+  export interface RenderEditParams<D = VxeTableDataRow> {
+    $table: VxeTableConstructor<D>
+    $grid: VxeGridConstructor<D> | null
+    column: VxeTableDefines.ColumnInfo<D>
     columnIndex: number
     $columnIndex: number
     rowid: string
-    row: any
+    row: D
     rowIndex: number
     $rowIndex: number
     isHidden: boolean
@@ -154,15 +162,15 @@ export namespace VxeGlobalRendererHandles {
     type: string
   }
 
-  export type RenderCellOptions = VxeColumnPropTypes.EditRender
-  export type RenderCellParams = {
-    $table: VxeTableConstructor
-    $grid: VxeGridConstructor | null
-    column: VxeTableDefines.ColumnInfo
+  export type RenderCellOptions<D = VxeTableDataRow> = VxeColumnPropTypes.EditRender<D>
+  export type RenderCellParams<D = VxeTableDataRow> = {
+    $table: VxeTableConstructor<D>
+    $grid: VxeGridConstructor<D> | null
+    column: VxeTableDefines.ColumnInfo<D>
     columnIndex: number
     $columnIndex: number
     rowid: string
-    row: any
+    row: D
     rowIndex: number
     $rowIndex: number
     isHidden: boolean

package/types/validator.d.ts

@@ -1,5 +1,5 @@
 import { VXEComponent } from './component'
-import { VxeTableDefines, VxeTableConstructor } from './table'
+import { VxeTableDefines, VxeTableDataRow, VxeTableConstructor } from './table'
 
 /* eslint-disable no-use-before-define */
 
@@ -12,42 +12,43 @@ export const VxeModuleValidator: VXEComponent<{ [key: string]: any }>
  */
 export const Validator: VXEComponent<{ [key: string]: any }>
 
-export interface TableValidatorMethods {
+export interface TableValidatorMethods<D = VxeTableDataRow> {
   /**
    * 手动清除校验
    */
-  clearValidate(): Promise<any>
+  clearValidate(): Promise<void>
   /**
    * 完整校验，默认校验当前表格数据，和 validate 的区别就是默认校验当前表格数据并且给有效数据中的每一行进行校验
    * @param rows 指定行
    * @param callback 回调函数
    */
-  fullValidate(rows?: boolean | object | any[] | ((errMap: VxeTableDefines.ValidatorErrorMapParams) => void), callback?: (errMap: VxeTableDefines.ValidatorErrorMapParams) => void): Promise<VxeTableDefines.ValidatorErrorMapParams>
+  fullValidate(rows?: boolean | object | any[] | ((errMap: VxeTableDefines.ValidatorErrorMapParams<D>) => void), callback?: (errMap: VxeTableDefines.ValidatorErrorMapParams<D>) => void): Promise<VxeTableDefines.ValidatorErrorMapParams<D>>
   /**
    * 快速校验，如果存在记录不通过的记录，则返回不再继续校验（异步校验除外）；
    * 如果第一个参数为 true 则校验当前表格数据，如果指定 row 或 rows 则校验指定一行或多行，如果不指定数据，则默认只校验临时变动的数据，例如新增或修改。该回调函数会在校验结束后被调用 callback(errMap)。若不传入回调函数，则会返回一个 promise
    * @param rows 指定行
    * @param callback 回调函数
    */
-  validate(rows?: boolean | object | any[] | ((errMap?: VxeTableDefines.ValidatorErrorMapParams) => void), callback?: (errMap?: VxeTableDefines.ValidatorErrorMapParams) => void): Promise<VxeTableDefines.ValidatorErrorMapParams>
+  validate(rows?: boolean | object | any[] | ((errMap?: VxeTableDefines.ValidatorErrorMapParams<D>) => void), callback?: (errMap?: VxeTableDefines.ValidatorErrorMapParams<D>) => void): Promise<VxeTableDefines.ValidatorErrorMapParams<D>>
 }
 
-export interface TableValidatorPrivateMethods {
-  validCellRules(type: any, row: any, column: any, val?: any): Promise<any>
-  hasCellRules(type: any, row: any, column: any): boolean
+export interface TableValidatorPrivateMethods<D = VxeTableDataRow> {
+  validCellRules(type: any, row: any, column: VxeTableDefines.ColumnInfo<any>, val?: any): Promise<any>
+  hasCellRules(type: any, row: any, column: VxeTableDefines.ColumnInfo<any>): boolean
   triggerValidate(type: any): Promise<any>
   showValidTooltip(params: any): void
 }
 
 declare module './grid' {
-  interface VxeGridMethods extends TableValidatorMethods { }
+  interface VxeGridMethods<D = VxeTableDataRow> extends TableValidatorMethods<D> { }
 }
 
 declare module './table' {
-  interface VxeTableMethods extends TableValidatorMethods { }
-  interface VxeTablePrivateMethods extends TableValidatorPrivateMethods { }
+  interface VxeTableMethods<D = VxeTableDataRow> extends TableValidatorMethods<D> { }
+  interface VxeTablePrivateMethods<D = VxeTableDataRow> extends TableValidatorPrivateMethods<D> { }
+  const a: VxeTableMethods
   namespace VxeTableDefines {
-    export interface ValidatorRule {
+    export interface ValidatorRule<D = VxeTableDataRow> {
       /**
        * 是否必填
        */
@@ -72,7 +73,7 @@ declare module './table' {
        * 使用自定义校验函数，接收一个 Promise
        * @param params 参数
        */
-      validator?(params: VxeTableDefines.ValidatorErrorParams): void | Error | Promise<void>
+      validator?(params: VxeTableDefines.ValidatorErrorParams<D>): void | Error | Promise<void>
       /**
        * 提示消息
        */
@@ -84,19 +85,19 @@ declare module './table' {
        */
       message?: string
     }
-    export interface ValidatorErrorParams {
-      $table: VxeTableConstructor
+    export interface ValidatorErrorParams<D = VxeTableDataRow> {
+      $table: VxeTableConstructor<D>
       cellValue: any
-      rule: ValidatorRule
-      rules: ValidatorRule[]
-      column: VxeTableDefines.ColumnInfo
+      rule: ValidatorRule<D>
+      rules: ValidatorRule<D>[]
+      column: VxeTableDefines.ColumnInfo<D>
       columnIndex: number
-      row: any
+      row: D
       rowIndex: number
       field: string
     }
-    export interface ValidatorErrorMapParams {
-      [key: string]: VxeTableDefines.ValidatorErrorParams[]
+    export interface ValidatorErrorMapParams<D = VxeTableDataRow> {
+      [key: string]: VxeTableDefines.ValidatorErrorParams<D>[]
     }
   }
 }