vxe-table 3.8.24 → 3.9.0-rc.1

package/types/form-item.d.ts

@@ -1,217 +0,0 @@
-import { VXETableComponent } from './component'
-import { Form, FormRule } from './form'
-import { RenderParams, RenderOptions, OptionProps, OptionGroupProps } from './v-x-e-table'
-
-/* eslint-disable no-use-before-define */
-
-/**
- * 表单 - 项
- */
-export class VxeFormItem extends VXETableComponent {
-  /**
-   * 标题
-   */
-  title?: string;
-  /**
-   * 字段名
-   */
-  field?: string;
-  /**
-   * 栅格占据的列数（共 24 分栏）
-   */
-  span?: string | number;
-  /**
-   * 内容对齐方式
-   */
-  align?: 'left' | 'center' | 'right';
-  /**
-   * 标题对齐方式
-   */
-  titleAlign?: 'left' | 'center' | 'right';
-  /**
-   * 标题宽度
-   */
-  titleWidth?: string | number;
-  /**
-   * 前缀配置项
-   */
-  titlePrefix?: FormItemTitleOptions;
-  /**
-   * 后缀配置项
-   */
-  titleSuffix?: FormItemTitleOptions;
-  vertical?: boolean
-  showTitle?: boolean
-  /**
-   * 重置时的默认值
-   */
-  resetValue?: any;
-  /**
-   * 该方法的返回值用来决定该项是否显示
-   */
-  visibleMethod?(params: { data: any, field: string }): boolean;
-  /**
-   * 默认收起
-   */
-  folding?: boolean;
-  /**
-   * 折叠节点
-   */
-  collapseNode?: boolean;
-  /**
-   * 项渲染配置项
-   */
-  itemRender?: FormItemRenderOptions;
-}
-export class FormItem extends VxeFormItem {}
-
-export interface FormItemOptions {
-  /**
-   * 标题
-   */
-  title?: string;
-  /**
-   * 字段名
-   */
-  field?: string;
-  /**
-   * 栅格占据的列数（共 24 分栏）
-   */
-  span?: string | number;
-  /**
-   * 内容对齐方式
-   */
-  align?: 'left' | 'center' | 'right';
-  /**
-   * 标题对齐方式
-   */
-  titleAlign?: 'left' | 'center' | 'right';
-  /**
-   * 标题宽度
-   */
-  titleWidth?: string | number;
-  /**
-   * 前缀配置项
-   */
-  titlePrefix?: FormItemTitleOptions;
-  /**
-   * 后缀配置项
-   */
-  titleSuffix?: FormItemTitleOptions;
-  showTitle?: boolean
-  /**
-   * 重置时的默认值
-   */
-  resetValue?: any;
-  /**
-   * 该方法的返回值用来决定该项是否显示
-   */
-  visibleMethod?(params: { data: any, field: string }): boolean;
-  /**
-   * 默认收起
-   */
-  folding?: boolean;
-  /**
-   * 折叠节点
-   */
-  collapseNode?: boolean;
-  /**
-   * 项渲染配置项
-   */
-  itemRender?: FormItemRenderOptions;
-  rules: FormRule[]
-}
-
-export interface FormItemTitleOptions {
-  message?: string;
-  enterable?: boolean;
-  theme?: string;
-  icon?: string;
-}
-
-/**
- * 项渲染配置项
- */
-export interface FormItemRenderOptions extends RenderOptions {
-  /**
-   * 下拉选项列表（需要渲染器支持）
-   */
-  options?: { [key: string]: any }[];
-  /**
-   * 下拉选项属性参数配置（需要渲染器支持）
-   */
-  optionProps?: OptionProps;
-  /**
-   * 下拉分组选项列表（需要渲染器支持）
-   */
-  optionGroups?: { [key: string]: any }[];
-  /**
-   * 下拉分组选项属性参数配置（需要渲染器支持）
-   */
-  optionGroupProps?: OptionGroupProps;
-  /**
-   * 渲染组件的内容（需要渲染器支持）
-   */
-  content?: string;
-  /**
-   * 默认值（需要渲染器支持）
-   */
-  defaultValue?: any;
-}
-
-/**
- * 项渲染参数
- */
-export interface FormItemRenderParams extends RenderParams {
-  /**
-   * 表单实例对象
-   */
-  $form: Form;
-  /**
-   * 表单数据
-   */
-  data: any;
-  field: string
-  /**
-   * @deprecated
-   */
-  property: string
-}
-
-/**
- * 项可视方法参数
- */
-export interface FormItemVisibleParams extends RenderParams {
-  /**
-   * 表单实例对象
-   */
-  $form: Form;
-  /**
-   * 表单数据
-   */
-  data: any;
-  field: string
-  /**
-   * @deprecated
-   */
-  property: string
-}
-
-/**
- * 项重置方法参数
- */
-export interface FormItemResetParams extends RenderParams {
-  /**
-   * 表单实例对象
-   */
-  $form: Form;
-  /**
-   * 表单数据
-   */
-  data: any;
-  field: string
-  /**
-   * @deprecated
-   */
-  property: string
-}

package/types/form.d.ts

@@ -1,149 +0,0 @@
-import { VXETableComponent } from './component'
-import { FormItemOptions } from './form-item'
-
-/* eslint-disable no-use-before-define */
-
-/**
- * 表单
- */
-export declare class VxeForm extends VXETableComponent {
-  loading?: boolean;
-  data?: any;
-  span?: string | number;
-  align?: 'left' | 'center' | 'right';
-  titleAlign?: 'left' | 'center' | 'right';
-  titleWidth?: string | number;
-  titleColon?: boolean;
-  vertical?: boolean
-  items?: FormItemOptions[];
-  rules?: FormVaildRules;
-  preventSubmit?: boolean;
-  validConfig?: {
-    autoPos?: boolean;
-  };
-
-  // methods
-  /**
-   * 重置表单
-   */
-  reset(): Promise<any>;
-  /**
-   * 对表单进行校验，参数为一个回调函数。该回调函数会在校验结束后被调用 callback(errMap)。若不传入回调函数，则会返回一个 promise
-   * @param callback 回调函数
-   */
-  validate(callback?: (errMap?: FormValidErrMapParams) => void): Promise<any>;
-  /**
-   * 对表单执行项进行校验，参数为一个回调函数。该回调函数会在校验结束后被调用 callback(errMap)。若不传入回调函数，则会返回一个 promise
-   * @param callback 回调函数
-   */
-  validateField(field?: string | string[], callback?: (errMap?: FormValidErrMapParams) => void): Promise<any>;
-  /**
-   * 手动清除校验状态，如果指定 field 则清除指定的项，否则清除整个表单
-   * @param field 字段名
-   */
-  clearValidate(field?: string | string[]): Promise<any>;
-  /**
-   * 更新项状态
-   * 当使用自定义渲染时可能会用到
-   * @param scope 插槽对象
-   */
-  updateStatus(scope: any): Promise<any>;
-  /**
-   * 获取表单项列表
-   */
-  getItems(): FormItemOptions[];
-  /**
-   * 手动切换折叠状态
-   */
-  toggleCollapse(): Promise<any>;
-  [key: string]: any;
-}
-export class Form extends VxeForm {}
-
-export interface FormRule {
-  /**
-   * 是否必填
-   */
-  required?: boolean;
-  /**
-   * 最小长度/值
-   */
-  min?: number;
-  /**
-   * 最大长度/值
-   */
-  max?: number;
-  /**
-   * 数据类型
-   */
-  type?: 'number' | 'string';
-  /**
-   * 使用正则表达式校验
-   */
-  pattern?: string | RegExp;
-  /**
-   * 使用自定义校验函数，接收一个 Promise
-   * @param params 参数
-   */
-  validator?(params: FormRuleValidatorParams): void | Error | Promise<any>
-  /**
-   * 提示消息
-   */
-  message?: string;
-  trigger?: 'change';
-  maxWidth?: number;
-}
-
-export interface FormRuleValidatorParams {
-  $form: Form,
-  itemValue: any,
-  rule: FormRule;
-  rules: FormRule[];
-  data: any;
-  field: string
-  /**
-   * @deprecated
-   */
-  property: string
-}
-
-/**
- * 校验规则配置项
- */
-export interface FormVaildRules {
-  [field: string]: FormRule[];
-}
-
-export interface FormValidErrParams {
-  $form: Form,
-  itemValue: any,
-  rule: FormRule;
-  data: any;
-  field: string
-  /**
-   * @deprecated
-   */
-  property: string
-}
-
-export interface FormValidErrMapParams {
-  [field: string]: FormValidErrParams[];
-}
-
-export interface FormOptions {
-  loading?: boolean;
-  data?: any;
-  span?: string | number;
-  size?: string;
-  align?: 'left' | 'center' | 'right';
-  titleAlign?: 'left' | 'center' | 'right';
-  titleWidth?: string | number;
-  titleColon?: boolean;
-  items?: FormItemOptions[];
-  rules?: FormVaildRules;
-  preventSubmit?: boolean;
-  validConfig?: {
-    autoPos?: boolean;
-  };
-  [key: string]: any;
-}

package/types/grid.d.ts

@@ -1,169 +0,0 @@
-import { VNode } from 'vue'
-import { Table } from './table'
-import { ColumnOptions } from './column'
-import { FormOptions } from './form'
-import { FormItemOptions } from './form-item'
-import { ToolbarOptions } from './toolbar'
-import { PagerOptions } from './pager'
-import { RowInfo } from './component'
-
-/* eslint-disable no-use-before-define */
-
-/**
- * 配置式表格
- */
-export declare class VxeGrid extends Table {
-  /**
-   * 列配置
-   */
-  columns?: GridColumns[];
-  /**
-   * 分页配置项
-   */
-  pagerConfig?: GridPagerConfig;
-  /**
-   * 数据代理配置项
-   */
-  proxyConfig?: GridProxyConfig;
-  proxyOpts: GridProxyConfig;
-  /**
-   * 工具栏配置
-   */
-  toolbarConfig?: GridToolbarConfig;
-  /**
-   * 表单配置项
-   */
-  formConfig?: GridFormOptions;
-  formOpts: GridFormOptions;
-
-  /**
-   * 给数据代理提交指令
-   * @param code 指令编码
-   */
-  commitProxy(code: string): Promise<any>;
-  /**
-   * 获取表单项列表
-   */
-  getFormItems(index?: number): FormItemOptions[];
-  /**
-   * 获取已标记删除的数据
-   */
-  getPendingRecords(): RowInfo[];
-  /**
-   * 切换表格最大化/还原
-   */
-  zoom(): Promise<boolean>;
-  /**
-   * 判断是否最大化显示
-   */
-  isMaximized(): boolean;
-  /**
-   * 如果表格处于常规状态，则最大化表格
-   */
-  maximize(): Promise<any>;
-  /**
-   * 如果表格处于最大化状态，则还原表格
-   */
-  revert(): Promise<any>;
-  /**
-   * 获取数据代理信息
-   */
-  getProxyInfo(): {
-    data: any;
-    filter: any;
-    form: any;
-    sort: any;
-    pager: any;
-    pendingRecords: any[];
-  };
-
-  [key: string]: any;
-}
-export class Grid extends VxeGrid {}
-
-export interface GridProxyQueryPageParams {
-  pageSize: number;
-  currentPage: number;
-}
-
-export interface GridProxyQuerySortParams {
-  order: string;
-  property: string;
-}
-
-export interface GridProxyQueryFiltersParams {
-  property: string;
-  values: any[];
-}
-
-export interface GridProxyConfig {
-  autoLoad?: boolean;
-  message?: boolean;
-  seq?: boolean;
-  sort?: boolean;
-  filter?: boolean;
-  form?: boolean;
-  response?: {
-    list?: string | null | ((params: { data: any }) => any[])
-    result?: string | ((params: { data: any }) => any[])
-    total?: string | ((params: { data: any }) => number)
-    message?: string | ((params: { data: any }) => string)
-  };
-  ajax?: {
-    query?(params: { page: GridProxyQueryPageParams, sort: GridProxyQuerySortParams, filters: GridProxyQueryFiltersParams[], form: any }, ...args: any[]): Promise<any>;
-    delete?(params: { body: { removeRecords: any[] } }, ...args: any[]): Promise<any>;
-    save?(params: { body: { insertRecords: any[], updateRecords: any[], removeRecords: any[], pendingRecords: any[] } }, ...args: any[]): Promise<any>;
-  }
-  [key: string]: any;
-
-  /**
-   * 已废弃，请使用 proxy-config.response
-   * @deprecated
-   */
-  props?: {
-    /**
-     * 已废弃，请使用 proxy-config.response.list
-     * @deprecated
-     */
-    list?: string | null
-    /**
-     * 已废弃，请使用 proxy-config.response.result
-     * @deprecated
-     */
-    result?: string
-    /**
-     * 已废弃，请使用 proxy-config.response.total
-     * @deprecated
-     */
-    total?: string
-    /**
-     * 已废弃，请使用 proxy-config.response.message
-     * @deprecated
-     */
-    message?: string
-  }
-}
-
-export interface GridPagerConfig extends PagerOptions {
-  [key: string]: any;
-}
-
-export interface GridColumns extends ColumnOptions {
-  children?: GridColumns[];
-}
-
-export interface GridToolbarConfig extends ToolbarOptions {
-  zoom?: boolean | {
-    escRestore?: boolean;
-    iconIn?: string;
-    iconOut?: string;
-  };
-  slots?: {
-    buttons?(): VNode[] | string[];
-    tools?(): VNode[] | string[];
-  }
-}
-
-export interface GridFormOptions extends FormOptions {
-  [key: string]: any;
-}

package/types/icon.d.ts

@@ -1,7 +0,0 @@
-import { VXETableComponent } from './component'
-
-/**
- * 内置图标库
- */
-export declare class VxeIcon extends VXETableComponent {}
-export class Icon extends VxeIcon {}

package/types/input.d.ts

@@ -1,163 +0,0 @@
-import { VXETableComponent } from './component'
-
-/* eslint-disable no-use-before-define */
-
-/**
- * 输入框
- */
-export declare class VxeInput extends VXETableComponent {
-  /**
-   * 绑定值
-   */
-  value?: string | number | Date;
-  /**
-   * 原生 name 属性
-   */
-  name?: string;
-  /**
-   * 渲染类型
-   */
-  type?: 'text' | 'search' | 'number' | 'integer' | 'float' | 'password' | 'date' | 'time' | 'datetime' | 'week' | 'month' | 'quarter' | 'year';
-  /**
-   * 当有值时，是否在右侧显示清除按钮
-   */
-  clearable?: boolean;
-  /**
-   * 是否只读
-   */
-  readonly?: boolean;
-  /**
-   * 是否禁用
-   */
-  disabled?: boolean;
-  /**
-   * 当值为空时，显示的占位符
-   */
-  placeholder?: string;
-  /**
-   * 原生 maxlength 属性
-   */
-  maxlength?: string | number;
-  /**
-   * 原生 autocomplete 属性
-   */
-  autocomplete?: string;
-  /**
-   * 原生 form 属性
-   */
-  form?: string;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，有效，设置日期可选范围的最小值
-   */
-  minDate?: string | number | Date;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，有效，设置日期可选范围的最大值
-   */
-  maxDate?: string | number | Date;
-  /**
-   * 只对 type=week 有效，设置起始周
-   */
-  startWeek?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，输入框中显示的日期格式
-   */
-  labelFormat?: string;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，绑定值的返回格式，默认返回 Date 类型，如果指定格式则返回字符串
-   */
-  valueFormat?: string;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，文本框是否允许输入
-   */
-  editable?: string;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，该方法 Function({ date, type }) 用于返回对应日期显示的节日
-   */
-  festivalMethod?(params: InputDateFestivalParams): InputDateFestivalInfo | void;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，该方法 Function({date}) 的返回值用来决定该日期是否允许选中
-   */
-  disabledMethod?(params: InputDateDisabledParams): boolean;
-  /**
-   * 只对 type=number|integer|float 有效，最小值
-   */
-  min?: string | number;
-  /**
-   * 只对 type=number|integer|float 有效，最大值
-   */
-  max?: string | number;
-  /**
-   * 只对 type=number|integer|float 有效，数字间隔
-   */
-  step?: string | number;
-  /**
-   * 只对 type=float 有效，小数位数
-   */
-  digits?: string | number;
-  /**
-   * 头部图标
-   */
-  prefixIcon?: string;
-  /**
-   * 尾部图标
-   */
-  suffixIcon?: string;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，固定显示弹框容器的方向
-   */
-  placement?: string;
-  /**
-   * 只对 type=date|week|month|quarter|year 有效，是否将弹框容器插入于 body 内
-   */
-  transfer?: boolean;
-
-  /**
-   * 获取焦点
-   */
-  focus(): Promise<any>;
-  /**
-   * 失去焦点
-   */
-  blur(): Promise<any>;
-}
-export class Input extends VxeInput {}
-
-export interface InputDateFestivalParams {
-  date: Date;
-  type: string;
-}
-
-export interface InputDateDisabledParams {
-  date: Date;
-}
-
-/**
- * 日期节日对象
- */
-export interface InputDateFestivalInfo {
-  /**
-   * 节日名称，如果重叠使用逗号隔开
-   */
-  label?: string;
-  /**
-   * 标记为重要节日
-   */
-  important?: boolean;
-  /**
-   * 显示左上角小圆点通知
-   */
-  notice?: boolean;
-  /**
-   * 显示右上角信息
-   */
-  extra?: string | {
-    /**
-     * 显示名称
-     */
-    label?: string;
-    /**
-     * 标记为重要信息
-     */
-    important?: boolean;
-  };
-}