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

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

@@ -8,25 +8,28 @@ import { VxeGlobalInterceptor } from './interceptor'
 import { VxeGlobalCommands } from './commands'
 import { VxeGlobalFormats } from './formats'
 import { VxeGlobalMenus } from './menus'
-import { VxeGlobalSetup } from './setup'
+import { VxeGlobalValidators } from './validators'
+import { VxeGlobalConfigMethod } from './setup'
+
+/* eslint-disable no-use-before-define */
 
 export type VxeGlobalI18n = (key: string, args?: any) => number | string;
 export type VxeGlobalTranslate = (key: string, args?: any) => string;
 export type VxeGlobalUse = (plugin: VXETablePluginObject, ...options: any[]) => VXETableCore;
 
-export const setup: VxeGlobalSetup;
-export const interceptor: VxeGlobalInterceptor;
-export const renderer: VxeGlobalRenderer;
-export const commands: VxeGlobalCommands;
-export const formats: VxeGlobalFormats;
-export const menus: VxeGlobalMenus;
-export const modal: ModalController;
-export const saveFile: SaveFileFunction;
-export const readFile: ReadFileFunction;
-export const print: PrintFunction;
-export const t: VxeGlobalI18n;
-export const _t: VxeGlobalTranslate;
-export const use: VxeGlobalUse;
+export const setup: VxeGlobalConfigMethod
+export const interceptor: VxeGlobalInterceptor
+export const renderer: VxeGlobalRenderer
+export const commands: VxeGlobalCommands
+export const formats: VxeGlobalFormats
+export const menus: VxeGlobalMenus
+export const modal: ModalController
+export const saveFile: SaveFileFunction
+export const readFile: ReadFileFunction
+export const print: PrintFunction
+export const t: VxeGlobalI18n
+export const _t: VxeGlobalTranslate
+export const use: VxeGlobalUse
 
 export interface VXETablePluginObject {
   install(vxetable: VXETableCore, ...options: any[]): void;
@@ -50,7 +53,7 @@ export interface VXETableCore {
   /**
    * 设置全局参数/获取所有参数
    */
-  setup: VxeGlobalSetup;
+  setup: VxeGlobalConfigMethod;
   /**
    * Table interceptor
    */
@@ -71,6 +74,10 @@ export interface VXETableCore {
    * Table context menu
    */
   menus: VxeGlobalMenus;
+  /**
+   * Validators table/form
+   */
+  validators: VxeGlobalValidators
   /**
    * 弹窗
    */
@@ -101,16 +108,16 @@ export interface VXETableCore {
 }
 
 /**
- * 一个基于 vue 的 PC 端表格组件，支持增删改查、虚拟滚动、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、虚拟列表、弹窗、自定义模板、渲染器、贼灵活的配置项等...  
+ * 一个基于 vue 的 PC 端表单/表格组件，支持增删改查、虚拟列表、虚拟树、懒加载、快捷菜单、数据校验、树形结构、打印导出、表单渲染、数据分页、弹窗、自定义模板、渲染器、JSON 配置式为零代码而设计...
  */
- export const VXETable: VXETableCore
+export const VXETable: VXETableCore
+
+export * from './renderer'
+export * from './interceptor'
+export * from './commands'
+export * from './formats'
+export * from './menus'
+export * from './validators'
+export * from './setup'
 
- export * from './renderer'
- export * from './interceptor'
- export * from './commands'
- export * from './formats'
- export * from './menus'
- export * from './setup'
- 
- export default VXETable
- 
+export default VXETable

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

@@ -19,7 +19,7 @@ export interface InterceptorParams extends GridRenderParams {
   $event: any;
 }
 
-export interface InterceptorKeydownParams extends InterceptorParams { }
+export type InterceptorKeydownParams = InterceptorParams
 
 export interface InterceptorExportParams extends InterceptorParams {
   options: TableExportConfig;

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

@@ -1,13 +1,24 @@
 import { MenuLinkParams } from '../menu'
 
-declare function menuFunc (params: MenuLinkParams, event: any): any;
+/* eslint-disable no-use-before-define */
+
+export namespace VxeGlobalMenusHandles {
+  export type MenusOption = {
+    menuMethod?: (params: MenuMethodParams, event: Event) => any
+  }
+  export type MenuMethodParams = MenuLinkParams
+}
 
 /**
  * 全局快捷菜单
  */
-export class VxeGlobalMenus {
-  mixin(map: { [type: string]: typeof menuFunc }): VxeGlobalMenus;
-  get(type: string): typeof menuFunc;
-  add(type: string, callback: typeof menuFunc): VxeGlobalMenus;
-  delete(type: string): VxeGlobalMenus;
+export interface VxeGlobalMenus {
+  mixin(opts: {
+    [code: string]: VxeGlobalMenusHandles.MenusOption | ((params: VxeGlobalMenusHandles.MenuMethodParams, event: Event) => any)
+  }): VxeGlobalMenus
+  has(code: string): boolean
+  get(code: string): VxeGlobalMenusHandles.MenusOption
+  add(code: string, options: VxeGlobalMenusHandles.MenusOption | ((params: VxeGlobalMenusHandles.MenuMethodParams, event: Event) => any)): VxeGlobalMenus
+  delete(code: string): void
+  forEach(callback: (options: VxeGlobalMenusHandles.MenusOption, code: string) => void): void
 }

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

@@ -10,6 +10,8 @@ import { ColumnFilterRenderOptions, ColumnFilterRenderParams, ColumnFilterMethod
 import { ToolbarButtonRenderOptions, ToolbarButtonRenderParams, ToolbarToolRenderOptions, ToolbarToolRenderParams } from '../toolbar'
 import { FormItemRenderOptions, FormItemRenderParams, FormItemVisibleParams, FormItemResetParams } from '../form-item'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 渲染器
  */
@@ -43,7 +45,7 @@ export interface RendererMapOptions {
 
   // 单元格渲染
   cellClassName?: string | ((params: ColumnCellRenderParams | ColumnEditRenderParams) => string | VNodeClassName)
-  cellStyle?:  VNodeStyle | ((params: ColumnCellRenderParams | ColumnEditRenderParams) => VNodeStyle)
+  cellStyle?: VNodeStyle | ((params: ColumnCellRenderParams | ColumnEditRenderParams) => VNodeStyle)
   renderHeader?(h: CreateElement, renderOpts: ColumnCellRenderOptions | ColumnEditRenderOptions, params: ColumnCellRenderParams | ColumnEditRenderParams): SlotVNodeType | SlotVNodeType[];
   renderDefault?(h: CreateElement, renderOpts: ColumnCellRenderOptions | ColumnEditRenderOptions, params: ColumnCellRenderParams | ColumnEditRenderParams): SlotVNodeType | SlotVNodeType[];
   renderFooter?(h: CreateElement, renderOpts: ColumnCellRenderOptions | ColumnEditRenderOptions, params: ColumnFooterRenderParams): SlotVNodeType | SlotVNodeType[];
@@ -101,11 +103,11 @@ export class RenderOptions {
   /**
    * 目标组件渲染的事件
    */
-  events?: { [key: string]: Function };
+  events?: { [key: string]: ((...angs: any[])=>any) };
   /**
    * 目标组件渲染的原生事件
    */
-  nativeEvents?: { [key: string]: Function };
+  nativeEvents?: { [key: string]: ((...angs: any[])=>any) };
   [key: string]: any;
 }
 

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

@@ -5,7 +5,7 @@ interface DefaultOptions {
   [key: string]: any;
 }
 
-export interface VXETableSetupOptions {
+export interface VXETableConfigOptions {
   size?: SizeType;
   zIndex?: number;
   version?: number;
@@ -39,36 +39,13 @@ export interface VXETableSetupOptions {
   [key: string]: any;
 }
 
-export interface VXETableGlobalConfig extends VXETableSetupOptions {
-  size: SizeType;
-  zIndex: number;
-  version: number;
-  emptyCell: string;
-  icon: {
-    [key: string]: string;
-  };
-  table: any;
-  grid: any;
-  export: {
-    types: {
-      [key: string]: 0 | 1 | 2;
-    }
-    [key: string]: any;
-  };
-  tooltip: DefaultOptions;
-  pager: any;
-  form: DefaultOptions;
-  input: DefaultOptions;
-  textarea: DefaultOptions;
-  select: DefaultOptions;
-  toolbar: any;
-  button: DefaultOptions;
-  radio: DefaultOptions;
-  checkbox: DefaultOptions;
-  switch: DefaultOptions;
-  modal: DefaultOptions;
-  list: DefaultOptions;
-  i18n(key: string, args?: any): string;
-}
+export type VxeGlobalConfigMethod = (options?: VXETableConfigOptions) => Required<VXETableConfigOptions>
 
-export type VxeGlobalSetup = (options?: VXETableSetupOptions) => VXETableGlobalConfig;
+/**
+ * @deprecated
+ */
+export type VXETableSetupOptions = VXETableConfigOptions
+/**
+ * @deprecated
+ */
+export type VxeGlobalSetup = VxeGlobalConfigMethod;

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

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

package/types/validator.d.ts

@@ -2,6 +2,8 @@ import { VXETableComponent } from './component'
 import { ColumnInfo } from './column'
 import { Table } from './table'
 
+/* eslint-disable no-use-before-define */
+
 /**
  * 表格校验
  */
@@ -32,7 +34,7 @@ export interface ColumnEditRule {
    * 使用自定义校验函数，接收一个 Promise
    * @param params 参数
    */
-  validator?: typeof ColumnValidatorMethod;
+  validator?: string | ((params: CellRuleValidatorParams) => void | Error | Promise<any>);
   /**
    * 提示消息
    */
@@ -41,9 +43,18 @@ export interface ColumnEditRule {
   maxWidth?: number;
 }
 
-export function ColumnValidatorMethod(params: ColumnEditValidErrParams): void;
-export function ColumnValidatorMethod(params: ColumnEditValidErrParams): Error;
-export function ColumnValidatorMethod(params: ColumnEditValidErrParams): Promise<any>;
+export interface CellRuleValidatorParams {
+  $table: Table,
+  cellValue: any,
+  rule: ColumnEditRule;
+  rules: ColumnEditRule[];
+  column: ColumnInfo;
+  columnIndex: number;
+  row: any;
+  rowIndex: number;
+}
+
+export function ColumnValidatorMethod(params: ColumnEditValidErrParams): void | Error | Promise<any>;
 
 export interface ColumnEditValidErrParams {
   $table: Table,