类型声明

enumType

/**enum枚举声明*/
type enumType = ArrayEnum[] | objectEnum;

/**enum枚举object类型声明*/
type objectEnum = Record<string, any>;

/**enum枚举数组类型声明*/
interface ArrayEnum {
  label: string;
  value: any;
}

Component

/** component组件类型声明 */
type Component =
  | 'AutoComplete'
  | 'Cascader'
  | 'Checkbox'
  | 'CheckboxButton'
  | 'Color'
  | 'Date'
  | 'Input'
  | 'InputNumber'
  | 'Radio'
  | 'RadioButton'
  | 'Rate'
  | 'Select'
  | 'SelectV2'
  | 'Slider'
  | 'Switch'
  | 'Time'
  | 'TimeSelect'
  | 'Transfer'
  | 'TreeSelect'
  | 'Upload'
  | 'MosoweUpload'
  | 'MosoweInputNumber';

MosoweFormFormItemType

/** MosoweFormFormItemType 配置 */
type MosoweFormFormItemType = Record<string, MosoweFormFormItemOption>;

MosoweFormFormItemOption

/** MosoweFormItemOption继承FormItem的属性，并新增自定义属性*/
interface MosoweFormFormItemOption extends Partial<FormItemProps> {
  component: Component; // 组件类型
  componentOption?: MosoweFormComponentOption; // 表单组件的配置
  unionProp?: string; // 下级关联字段，本字段数据更新，下级关联字段清空，或者使用 = 将默认值带上，多个`&`逗号分割，如需额外的操作，可以同时使用`change`属性
  visible?: boolean; // 组件显隐，display
  hidden?: boolean; // 组件隐藏 v-if
  justShow?: boolean; // 仅展示
  tooltip?: string; // 配置formItem的tooltip提示
  unit?: string; // form-item 尾部文案，一般用作单位
  transform?: (value: any) => any; // 提交或重置的时候，需要转字段的
  [k: string]: any; // 其他属性
}

MosoweFormComponentOption

/** MosoweFormComponentOption 继承 所有的表单项属性 */
interface MosoweFormComponentOption extends allFormEl {
  /**'Select', 'Radio', 'RadioButton', 'Checkbox', 'CheckboxButton'组件的选项列表 */
  enum?: enumType;
  /** 相关组件的prefix插槽的属性传值 */
  prefix?: string;
  /** 相关组件的suffix插槽的属性传值 */
  suffix?: string;
  /** 相关组件的prepend插槽的属性传值 */
  prepend?: string;
  /** 相关组件的append插槽的属性传值 */
  append?: string;
  /**MosoweUpload组件文件大小限制，支持number类型及string带单位 b,kb,mb */
  fileSize?: string | number;
  /**MosoweUpload 组件文件大小限制异常提示语 */
  sizeError?: string; // CustomUpload组件
  /**MosoweUpload 组件文件宽度限制 */
  width?: number;
  /**MosoweUpload 组件文件高度限制 */
  height?: number;
  /**MosoweUpload 组件文件宽高异常提示 */
  whError?: string;
  /**MosoweUpload 组件文件格式异常提示 */
  acceptError?: string;
  /**MosoweUpload 组件上传样式 */
  listType?: 'text' | 'picture' | 'picture-card' | 'drag';
  /**MosoweUpload 组件上传提示语 */
  notice?: string;
  /**MosoweUpload 组件上传区文案 */
  text?: string;
  /**MosoweUpload 组件校验成功后处理 */
  verifySuccess?: any;
  /**MosoweUpload 组件内置校验完成后需要做的一些其他校验，return promise */
  otherVerify?: string;
  /**MosoweUpload 组件接口返回参数指定存放文件路径的键 */
  apiKey?: string;
  /**MosoweUpload 组件上传后文件路径需要加前缀的 */
  realmName?: string;
  /** MosoweUpload 组件只读时，图片列表为空时文案*/
  emptyText?: string;
  /** MosoweUpload 只读*/
  justShow?: boolean;
  /** MosoweUpload 组件自动上传*/
  autoUpload?: boolean;
  [k: string]: any; // 表单组件属性及事件
}

贡献者

mosowe