vxe-table 4.5.0-beta.12 → 4.5.0-beta.13

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

@@ -6,6 +6,7 @@ import { VxeGlobalInterceptor } from './interceptor'
 import { VxeGlobalCommands } from './commands'
 import { VxeGlobalFormats } from './formats'
 import { VxeGlobalMenus } from './menus'
+import { VxeGlobalValidators } from './validators'
 import { VxeGlobalHooks } from './hooks'
 import { VxeGlobalSetup } from './setup'
 
@@ -39,6 +40,7 @@ export const renderer: VxeGlobalRenderer
 export const commands: VxeGlobalCommands
 export const formats: VxeGlobalFormats
 export const menus: VxeGlobalMenus
+export const validators: VxeGlobalValidators
 export const hooks: VxeGlobalHooks
 export const modal: ModalController
 export const saveFile: SaveFileFunction
@@ -93,6 +95,10 @@ export interface VXETableCore {
    * Table context menu
    */
   menus: VxeGlobalMenus
+  /**
+   * Validators table/form
+   */
+  validators: VxeGlobalValidators
   /**
    * Table VxeGlobalHooks API
    */
@@ -131,7 +137,7 @@ export interface VXETableCore {
 }
 
 /**
- * 一个基于 vue 的 PC 端表格组件，支持增删改查、虚拟滚动、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、虚拟列表、弹窗、自定义模板、渲染器、贼灵活的配置项等...
+ * 一个基于 vue 的 PC 端表格组件，支持增删改查、虚拟列表、虚拟树、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、弹窗、自定义模板、渲染器、JSON 配置式为零代码而设计...
  */
 export const VXETable: VXETableCore
 
@@ -140,6 +146,7 @@ export * from './interceptor'
 export * from './commands'
 export * from './formats'
 export * from './menus'
+export * from './validators'
 export * from './hooks'
 export * from './setup'
 

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

@@ -5,18 +5,30 @@ import { VxeGlobalRendererHandles } from './renderer'
 /* eslint-disable no-use-before-define */
 
 export namespace VxeGlobalMenusHandles {
-  export type MenusCallback<D = VxeTableDataRow> = (params: MenusCallbackParams<D>, event: Event) => any
-
+  export type MenusOption<D = VxeTableDataRow> = {
+    menuMethod?: (params: MenuMethodParams<D>, event: Event) => any
+  }
   interface MenusParams<D = VxeTableDataRow> {
     $grid: VxeGridConstructor<D> | null
     $table: VxeTableConstructor<D> & VxeTablePrivateMethods<D>
   }
-  export interface MenusCallbackParams<D = VxeTableDataRow> extends MenusParams<D>, VxeGlobalRendererHandles.RenderCellParams<D> {
+  export interface MenuMethodParams<D = VxeTableDataRow> extends MenusParams<D>, VxeGlobalRendererHandles.RenderCellParams<D> {
     $grid: VxeGridConstructor<D> | null
     $table: VxeTableConstructor<D> & VxeTablePrivateMethods<D>
     $event: MouseEvent
     menu: VxeTableDefines.MenuFirstOption | VxeTableDefines.MenuChildOption
   }
+
+  /**
+   * 请使用 MenusOption
+   * @deprecated
+   */
+  export type MenusCallback = MenusOption
+  /**
+   * 请使用 MenuMethodParams
+   * @deprecated
+   */
+  export interface MenusCallbackParams<D = VxeTableDataRow> extends MenuMethodParams<D> {}
 }
 
 /**
@@ -24,11 +36,11 @@ export namespace VxeGlobalMenusHandles {
  */
 export interface VxeGlobalMenus {
   mixin(options: {
-    [code: string]: VxeGlobalMenusHandles.MenusCallback<any>
+    [code: string]: VxeGlobalMenusHandles.MenusOption<any> | ((params: VxeGlobalMenusHandles.MenuMethodParams<any>, event: Event) => any)
   }): VxeGlobalMenus
   has(code: string): boolean
-  get(code: string): VxeGlobalMenusHandles.MenusCallback<any>
-  add(code: string, callback: VxeGlobalMenusHandles.MenusCallback<any>): VxeGlobalMenus
+  get(code: string): VxeGlobalMenusHandles.MenusOption<any>
+  add(code: string, options: VxeGlobalMenusHandles.MenusOption<any> | ((params: VxeGlobalMenusHandles.MenuMethodParams<any>, event: Event) => any)): VxeGlobalMenus
   delete(code: string): void
-  forEach(callback: (options: VxeGlobalMenusHandles.MenusCallback<any>, code: string) => void): void
+  forEach(callback: (options: VxeGlobalMenusHandles.MenusOption<any>, code: string) => void): void
 }

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

@@ -0,0 +1,30 @@
+import { VxeTableDefines, VxeTableDataRow } from '../table'
+import { VxeFormDefines } from '../form'
+
+/* eslint-disable no-use-before-define */
+
+export namespace VxeGlobalValidatorsHandles {
+  export interface ValidatorsOptions<D = VxeTableDataRow> {
+    itemValidatorMethod?: ItemValidatorMethod
+    cellValidatorMethod?: CellValidatorMethod<D>
+  }
+
+  export type ItemValidatorMethod = (params: ItemValidatorParams, ...args: any[]) => void | Error | Promise<any>
+  export type CellValidatorMethod<D = VxeTableDataRow> = (params: CellValidatorParams<D>, ...args: any[]) => void | Error | Promise<any>
+  export interface ItemValidatorParams extends VxeFormDefines.RuleValidatorParams {}
+  export interface CellValidatorParams<D = VxeTableDataRow> extends VxeTableDefines.RuleValidatorParams<D> {}
+}
+
+/**
+ * 全局快捷菜单
+ */
+export interface VxeGlobalValidators {
+  mixin(options: {
+    [code: string]: VxeGlobalValidatorsHandles.ValidatorsOptions<any>
+  }): VxeGlobalValidators
+  has(code: string): boolean
+  get(code: string): VxeGlobalValidatorsHandles.ValidatorsOptions<any>
+  add(code: string, callback: VxeGlobalValidatorsHandles.ValidatorsOptions<any>): VxeGlobalValidators
+  delete(code: string): void
+  forEach(callback: (options: VxeGlobalValidatorsHandles.ValidatorsOptions<any>, code: string) => void): void
+}

package/types/validator.d.ts

@@ -1,5 +1,6 @@
 import { VXEComponent } from './component'
 import { VxeTableDefines, VxeTableDataRow, VxeTableConstructor } from './table'
+import { VxeGridConstructor } from './grid'
 import { VxeColumnPropTypes } from './column'
 
 /* eslint-disable no-use-before-define */
@@ -71,7 +72,7 @@ declare module './table' {
        * 使用自定义校验函数，接收一个 Promise
        * @param params 参数
        */
-      validator?(params: VxeTableDefines.ValidatorErrorParams<D>): void | Error | Promise<void>
+      validator?: string | ((params: RuleValidatorParams<D>) => void | Error | Promise<void>)
       /**
        * 提示消息
        */
@@ -83,6 +84,18 @@ declare module './table' {
        */
       message?: string
     }
+    export interface RuleValidatorParams<D = VxeTableDataRow> {
+      $table: VxeTableConstructor<D>
+      $grid: VxeGridConstructor<D> | null
+      cellValue: any
+      rule: ValidatorRule<D>
+      rules: ValidatorRule<D>[]
+      column: VxeTableDefines.ColumnInfo<D>
+      columnIndex: number
+      row: D
+      rowIndex: number
+      field: string
+    }
     export interface ValidatorErrorParams<D = VxeTableDataRow> {
       $table: VxeTableConstructor<D>
       cellValue: any