vxe-pc-ui 1.2.0 → 1.4.0

package/types/components/table-module/custom.d.ts

@@ -0,0 +1,32 @@
+/* eslint-disable no-use-before-define */
+
+export interface VxeCustomPanel {
+}
+
+export interface TableCustomMethods<D = any> {
+  /**
+   * 打开自定义面板
+   */
+  openCustom(): Promise<void>
+  /**
+   * 处理自定义面板
+   */
+  closeCustom(): Promise<void>
+}
+
+export interface TableCustomPrivateMethods<D = any> {
+  checkCustomStatus(): void
+  emitCustomEvent(type: string, evnt: Event): void
+  triggerCustomEvent(evnt: MouseEvent): void
+  customOpenEvent (evnt: Event): void
+  customColseEvent (evnt: Event): void
+}
+
+declare module '../grid' {
+  export interface VxeGridMethods<D = any> extends TableCustomMethods<D> { }
+}
+
+declare module '../table' {
+  export interface VxeTableMethods<D = any> extends TableCustomMethods<D> { }
+  export interface VxeTablePrivateMethods<D = any> extends TableCustomPrivateMethods<D> { }
+}

package/types/components/table-module/edit.d.ts

@@ -0,0 +1,166 @@
+import { VxeTableDefines } from '../table'
+
+/* eslint-disable no-use-before-define */
+
+export interface TableEditMethods<D = any> {
+  /**
+   * 往表格插入临时数据，从第一行新增一行或多行新数据
+   * @param records 新数据
+   */
+  insert(records: any): Promise<{ row: D, rows: D[] }>
+  /**
+   * 往表格指定行中插入临时数据
+   * 如果 row 为空则从插入到顶部，如果为树结构，则插入到目标节点顶部
+   * 如果 row 为 -1 则从插入到底部，如果为树结构，则插入到目标节点底部
+   * 如果 row 为有效行则插入到该行的位置，如果为树结构，则有插入到效的目标节点该行的位置
+   * @param {Object/Array} records 新的数据
+   * @param {Row} row 指定行
+   */
+  insertAt(records: any, row: any | -1 | null): Promise<{ row: D, rows: D[] }>
+  /**
+   * 往表格在指定行中的下一行插入临时数据
+   * 如果 row 为空则从插入到顶部，如果为树结构，则插入到目标节点顶部
+   * 如果 row 为 -1 则从插入到底部，如果为树结构，则插入到目标节点底部
+   * 如果 row 为有效行则插入到该行的下一行位置，如果为树结构，则有插入到效的目标节点该行的下一行位置
+   * @param records records 新的数据
+   * @param row row 指定行
+   */
+  insertNextAt(records: any, row: any | -1 | null): Promise<{ row: D, rows: D[] }>
+  /**
+   * 删除指定行数据，指定 row 或 [row, ...] 删除多条数据，如果为空则删除所有数据
+   * @param rows 指定行
+   */
+  remove(rows?: any | any[]): Promise<{ row: D, rows: D[] }>
+  /**
+   * 删除复选框选中的行数据
+   */
+  removeCheckboxRow(): Promise<{ row: D, rows: D[] }>
+  /**
+   * 删除单选框选中的行数据
+   */
+  removeRadioRow(): Promise<{ row: D, rows: D[] }>
+  /**
+   * 删除当前行选中的行数据
+   */
+  removeCurrentRow(): Promise<{ row: D, rows: D[] }>
+  /**
+   * 获取表格数据集
+   * 获取新增、删除、更改的数据
+   */
+  getRecordset(): {
+    insertRecords: D[]
+    removeRecords: D[]
+    updateRecords: D[]
+    pendingRecords: D[]
+  }
+  /**
+   * 用于 edit-config，获取新增的临时数据
+   */
+  getInsertRecords(): D[]
+  /**
+   * 获取已删除的数据
+   */
+  getRemoveRecords(): D[]
+  /**
+   * 用于 edit-config，获取已修改的数据
+   */
+  getUpdateRecords(): D[]
+  /**
+   * 请使用 getEditRecord
+   * @deprecated
+   */
+  getActiveRecord(): {
+    row: D
+    rowIndex: number
+    $rowIndex: number
+    column: VxeTableDefines.ColumnInfo<D>
+    columnIndex: number
+    $columnIndex: number
+    cell: HTMLElement
+  }
+  /**
+   * 用于 edit-config，获取已激活的行数据
+   */
+  getEditRecord(): {
+    row: D
+    rowIndex: number
+    $rowIndex: number
+    column: VxeTableDefines.ColumnInfo<D>
+    columnIndex: number
+    $columnIndex: number
+    cell: HTMLElement
+  }
+  /**
+   * 用于 mouse-config.selected，获取选中的单元格信息
+   */
+  getSelectedCell(): {
+    row: D
+    column: VxeTableDefines.ColumnInfo<D>
+  }
+  /**
+   * 请使用 clearEdit()
+   * @deprecated
+   */
+  clearActived(evnt?: Event): Promise<any>
+  /**
+   * 手动清除单元格激活状态
+   */
+  clearEdit(evnt?: Event): Promise<any>
+  /**
+   * 手动清除单元格选中状态
+   */
+  clearSelected(): Promise<any>
+  /**
+   * 请使用 isEditByRow
+   * @deprecated
+   */
+  isActiveByRow(row: any): boolean
+  /**
+   * 用于 edit-config，判断行是否为激活编辑状态
+   * @param row 指定行
+   */
+  isEditByRow(row: any): boolean
+  /**
+   * 请使用 setEditRow
+   * @deprecated
+   */
+  setActiveRow(row: any): Promise<void>
+  /**
+   * 用于 edit-config，激活行编辑并默认激活第一个列，也可以指定列
+   * @param row 指定行
+   */
+  setEditRow(row: any, fieldOrColumn?: string | VxeTableDefines.ColumnInfo<any>): Promise<void>
+  /**
+   * 请使用 setEditCell
+   * @deprecated
+   */
+  setActiveCell(row: any, fieldOrColumn: string | VxeTableDefines.ColumnInfo<any>): Promise<void>
+  /**
+   * 用于 edit-config，激活单元格编辑
+   * @param row 指定行
+   * @param field 字段名
+   */
+  setEditCell(row: any, fieldOrColumn: string | VxeTableDefines.ColumnInfo<any>): Promise<void>
+  /**
+   * 用于 mouse-config.mouse-config，选中某个单元格
+   * @param row 指定行
+   * @param field 字段名
+   */
+  setSelectCell(row: any, fieldOrColumn: string | VxeTableDefines.ColumnInfo<any>): Promise<void>
+}
+
+export interface TableEditPrivateMethods<D = any> {
+  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' {
+  export interface VxeGridMethods<D = any> extends TableEditMethods<D> { }
+}
+
+declare module '../table' {
+  export interface VxeTableMethods<D = any> extends TableEditMethods<D> { }
+  export interface VxeTablePrivateMethods<D = any> extends TableEditPrivateMethods<D> { }
+}

package/types/components/table-module/export.d.ts

@@ -0,0 +1,81 @@
+import { VxeTablePropTypes } from '../table'
+
+/* eslint-disable no-use-before-define */
+
+export interface TableExportMethods<D = any> {
+  /**
+   * 打开高级导出
+   * @param options 参数
+   */
+  openExport(options?: VxeTablePropTypes.ExportConfig): void
+  /**
+   * 将表格数据导出
+   * @param options 参数
+   */
+  exportData(options?: VxeTablePropTypes.ExportConfig): Promise<any>
+  /**
+   * 打开高级导入
+   * @param options 参数
+   */
+  openImport(options?: VxeTablePropTypes.ImportConfig): void
+  /**
+   * 将数据导入表格
+   * @param options 参数
+   */
+  importData(options?: VxeTablePropTypes.ImportConfig): Promise<any>
+  /**
+   * 将一个文件的数据导入表格
+   * @param file 文件流
+   * @param options 参数
+   */
+  importByFile(file: File, options: VxeTablePropTypes.ImportConfig): Promise<any>
+  /**
+   * 保存文件到本地
+   * @param options
+   */
+  saveFile: SaveFileFunction
+  /**
+   * 读取本地文件
+   * @param options 参数
+   */
+  readFile: ReadFileFunction
+  /**
+   * 打印表格数据
+   * @param options 参数
+   */
+  print: PrintFunction
+  /**
+   * 打开高级打印
+   * @param options 参数
+   */
+  openPrint(options?: VxeTablePropTypes.PrintConfig): void
+}
+
+export interface TableExportPrivateMethods<D = any> { }
+
+declare module '../grid' {
+  export interface VxeGridMethods<D = any> extends TableExportMethods<D> { }
+}
+
+declare module '../table' {
+  export interface VxeTableMethods<D = any> extends TableExportMethods<D> { }
+  export interface VxeTablePrivateMethods<D = any> extends TableExportPrivateMethods<D> { }
+}
+
+export type SaveFileFunction = (options: {
+  filename: string
+  type: string
+  content: string | Blob
+}) => Promise<any>
+
+export type ReadFileFunction = (options?: {
+  multiple?: boolean
+  types?: string[]
+  message?: boolean
+}) => Promise<{
+  status: boolean
+  files: FileList
+  file: File
+}>
+
+export type PrintFunction = (options?: VxeTablePropTypes.PrintConfig) => any

package/types/components/table-module/filter.d.ts

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

package/types/components/table-module/index.d.ts

@@ -0,0 +1,7 @@
+export * from './filter'
+export * from './menu'
+export * from './edit'
+export * from './export'
+export * from './keyboard'
+export * from './validator'
+export * from './custom'

package/types/components/table-module/keyboard.d.ts

@@ -0,0 +1,22 @@
+import { any } from '../table'
+
+/* eslint-disable no-use-before-define */
+
+export interface TableKeyboardMethods<D = any> {}
+
+export interface TableKeyboardPrivateMethods<D = any> {
+  moveTabSelected(args: any, isLeft: any, evnt: any): void
+  moveCurrentRow(isUpArrow: any, isDwArrow: any, evnt: any): void
+  moveSelected(args: any, isLeftArrow: any, isUpArrow: any, isRightArrow: any, isDwArrow: any, evnt: any): void
+  triggerHeaderCellMousedownEvent(evnt: any, params: any): void
+  triggerCellMousedownEvent(evnt: any, params: any): void
+ }
+
+declare module '../grid' {
+  export interface VxeGridMethods<D = any> extends TableKeyboardMethods<D> { }
+}
+
+declare module '../table' {
+  export interface VxeTableMethods<D = any> extends TableKeyboardMethods<D> { }
+  export interface VxeTablePrivateMethods<D = any> extends TableKeyboardPrivateMethods<D> { }
+}

package/types/components/table-module/menu.d.ts

@@ -0,0 +1,54 @@
+/* eslint-disable no-use-before-define */
+
+export interface TableMenuMethods<D = any> {
+  /**
+   * 手动关闭快捷菜单
+   */
+  closeMenu(): Promise<any>
+}
+
+export interface TableMenuPrivateMethods<D = any> {
+  moveCtxMenu(evnt: any, ctxMenuStore: any, property: any, hasOper: boolean, operRest: any, menuList: any): void
+  handleOpenMenuEvent(evnt: Event, type: 'header' | 'body' | 'footer', params: any): void
+  handleGlobalContextmenuEvent(evnt: any): void
+  ctxMenuMouseoverEvent(evnt: any, item: any, child?: any): void
+  ctxMenuMouseoutEvent(evnt: any, item: any): void
+  ctxMenuLinkEvent(evnt: any, menu: any): void
+}
+
+declare module '../grid' {
+  export interface VxeGridMethods<D = any> extends TableMenuMethods<D> { }
+}
+
+declare module '../table' {
+  export interface VxeTableMethods<D = any> extends TableMenuMethods<D> { }
+  export interface VxeTablePrivateMethods<D = any> extends TableMenuPrivateMethods<D> { }
+  export namespace VxeTableDefines {
+    export interface MenuOptions {
+      disabled?: boolean
+      options?: MenuFirstOption[][]
+    }
+    export interface MenuFirstOption {
+      code?: string
+      name?: string
+      prefixIcon?: string
+      suffixIcon?: string
+      className?: string
+      visible?: boolean
+      disabled?: boolean
+      children?: MenuChildOption[]
+      params?: any
+      [key: string]: any
+    }
+    export interface MenuChildOption {
+      code?: string
+      name?: string
+      prefixIcon?: string
+      className?: string
+      visible?: boolean
+      disabled?: boolean
+      params?: any
+      [key: string]: any
+    }
+  }
+}

package/types/components/table-module/validator.d.ts

@@ -0,0 +1,104 @@
+import { VxeTableDefines, VxeTableConstructor } from '../table'
+import { VxeGridConstructor } from '../grid'
+import { VxeColumnPropTypes } from '../column'
+
+/* eslint-disable no-use-before-define */
+
+export interface TableValidatorMethods<D = any> {
+  /**
+   * 手动清除校验
+   */
+  clearValidate(rows?: any, fieldOrColumn?: VxeColumnPropTypes.Field | VxeTableDefines.ColumnInfo<any> | VxeColumnPropTypes.Field[] | VxeTableDefines.ColumnInfo<any>[]): Promise<void>
+  /**
+   * 完整校验，默认校验当前表格数据，和 validate 的区别就是默认校验当前表格数据并且给有效数据中的每一行进行校验
+   * @param rows 指定行
+   */
+  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 指定行
+   */
+  validate(rows?: boolean | object | any[] | ((errMap?: VxeTableDefines.ValidatorErrorMapParams<D>) => void), callback?: (errMap?: VxeTableDefines.ValidatorErrorMapParams<D>) => void): Promise<VxeTableDefines.ValidatorErrorMapParams<D>>
+}
+
+export interface TableValidatorPrivateMethods<D = any> {
+  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' {
+  export interface VxeGridMethods<D = any> extends TableValidatorMethods<D> { }
+}
+
+declare module '../table' {
+  export interface VxeTableMethods<D = any> extends TableValidatorMethods<D> { }
+  export interface VxeTablePrivateMethods<D = any> extends TableValidatorPrivateMethods<D> { }
+  export namespace VxeTableDefines {
+    export interface ValidatorRule<D = any> {
+      /**
+       * 是否必填
+       */
+      required?: boolean
+      /**
+       * 最小长度/值
+       */
+      min?: number | string
+      /**
+       * 最大长度/值
+       */
+      max?: number | string
+      /**
+       * 数据类型
+       */
+      type?: 'number' | 'string' | 'array' | '' | null
+      /**
+       * 使用正则表达式校验
+       */
+      pattern?: string | RegExp
+      /**
+       * 使用自定义校验函数，接收一个 Promise
+       * @param params 参数
+       */
+      validator?: string | ((params: RuleValidatorParams<D>) => void | Error | Promise<void>)
+      /**
+       * 提示消息
+       */
+      content?: string
+      trigger?: 'blur' | 'change' | 'manual' | '' | null
+      maxWidth?: number
+      /**
+       * @deprecated 已废弃，请使用 content
+       */
+      message?: string
+    }
+    export interface RuleValidatorParams<D = any> {
+      $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 = any> {
+      $table: VxeTableConstructor<D>
+      cellValue: any
+      rule: ValidatorRule<D>
+      rules: ValidatorRule<D>[]
+      column: VxeTableDefines.ColumnInfo<D>
+      columnIndex: number
+      row: D
+      rowIndex: number
+      field: string
+    }
+    export interface ValidatorErrorMapParams<D = any> {
+      [key: string]: VxeTableDefines.ValidatorErrorParams<D>[]
+    }
+  }
+}