vue 封装一个高质量的表单通用组件

 // 定义el-form的ref继承原有组件的form属性
 export interface FormInstance {
  reGISterLabelWidth(width: number, oldWidth: number): void,
  deregisterLabelWidth(width: number): void,
  autoLabelWidth: string | undefined,
  emit: (evt: string, ...args: any[]) => void,
  labelSuffix: string,
  inline?: boolean,
  model?: Record<string, unknown>,
  size?: string,
  showMessage?: boolean,
  labelPosition?: string,
  labelWidth?: string,
  rules?: Record<string, unknown>,
  statusIcon?: boolean,
  hideRequiredAsterisk?: boolean,
  disabled?: boolean,
  validate: (callback?: Callback) => Promise<boolean>,
  resetFields: () => void,
  clearValidate: (props?: string | string[]) => void,
  validateField: (props: string | string[], cb: ValidateFieldCallback) => void,
}

// 表单每一项的配置选项
export interface FormOptions {
  // 表单项显示的元素
  type: '',// 定义表单项类型
  value?: any, // 表单项的值
  label?: string,// 表单项label
  prop?: string,// 表单项的标识
  rules?: RuleItem[],// 表单项的验证规则
  placeholder?: string,// 表单项的占位符
  attrs?: {  // 按需定义不同表单类型属性
    ...
  },
  children?: FormOptions[],// 表单项的子元素，可能存在嵌套表单组件，如select
  ....// 适当扩展我们需要的属性，比如上传组件属性，行布局表单属性
}

// 核心代码：封装验证方式时的属性
export interface RuleItem {
  type?: RuleType; // 验证种类
  required?: boolean;// 是否必填
  pattern?: RegExp | string;// 验证方式匹配
  min?: number; // 表单项最小值
  max?: number; // 表单项最大值
  len?: number; // 表单项字符长度
  trigger?: string | string[];// 验证触发方式
  ....
}

<!--表单框架：model就是传入的表单对象，rules就是传入的验证对象 -->
  <el-form
    v-if="model"
    :validate-on-rule-change="false"
    v-bind="$attrs"
    :model="model"
    :rules="rules"
    ref="form"
  >
    ... <!--表单项封装 -->
  </el-form>

<template v-for="(item, index) in options" :key="index">
    <el-form-item  :label="item.label" :prop="item.prop">
      <component
        v-else
        :is="`el-${item.type}`"
        v-bind="item.attrs"
        v-model="model[item?.prop!]"
      >
      </component>
    </el-form-item>
</template>

<template v-for="(item, index) in options" :key="index">
    <el-form-item
      v-if="item.children && item.children.length"
      :label="item.label"
      :prop="item.prop"
    >
      <component
        :is="`el-${item.type}`"
        v-bind="item.attrs"
        v-model="model[item?.prop!]"
      >
        <component
          v-for="(child, i) in item.children"
          :key="i"
          :label="child.label"
          :value="child.value"
          :is="`el-${child.type}`"
        >
        </component>
      </component>
    </el-form-item>
</template>

<div id="editor" v-else-if="item.type === 'editor'"></div>

import E from 'wangeditor';
// 遍历传入的prop的options对象，初始化富文本
if (item.type === 'editor') {
// 初始化富文本
nextTick(() => {
  if (document.getElementById('editor')) {
    const editor = new E('#editor');
    editor.config.placeholder = item.placeholder!;
    editor.create();
    // 初始化富文本的内容
    editor.txt.html(item.value);
    editor.config.onchange = (newHtml: string) => {
      model.value[item.prop!] = newHtml;
    };
    edit.value = editor;
  }
});
}

<el-form-item  :label="item.label" :prop="item.prop">
  <!-- 上传表单 -->
  <el-upload
    v-if="item.type === 'upload'"
    v-bind="item.uploadAttrs"
    :on-preview="onPreview"
    :on-remove="onRemove"
    :on-success="onSuccess"
    :on-error="onError"
    :on-progress="onProgress"
    :on-change="onChange"
    :before-upload="beforeUpload"
    :before-remove="beforeRemove"
    :Http-request="httpRequest"
  >
    <slot name="uploadArea"></slot>
    <slot name="uploadTip"></slot>
  </el-upload>
</el-form-item>

<template v-if="item.type === 'row'">
    <el-row :gutter="item.rowGutter">
    <el-col
    v-for="(jtem, jndex) in item.cols"
    v-bind="jtem.colOption"
    :key="jndex"
    >
    <el-form-item :label="jtem.label" :prop="jtem.prop">
      <component
        :is="`el-${jtem.type}`"
        v-bind="jtem.attrs"
        v-model="model[jtem?.prop!]"
      >
        <template v-if="jtem.children && jtem.children.length">
          <component
            v-for="(child, i) in jtem.children"
            :key="i"
            :label="child.label"
            :value="child.value"
            :is="`el-${child.type}`"
          >
          </component>
        </template>
      </component>
    </el-form-item>
    </el-col>
    </el-row>
</template>

<el-form-item>
      <slot name="action" :form="form" :model="model"></slot>
</el-form-item>

<lib-form
  ref="form"
  label-width="100px"
  :options="options"
  @on-change="handleChange"
  @before-upload="handleBeforeUpload"
  @on-preview="handlePreview"
  @on-remove="handleRemove"
  @before-remove="beforeRemove"
  @on-success="handleSuccess"
  @on-exceed="handleExceed"
>
  <template #uploadArea>
    <el-button size="small" type="primary">Click to upload</el-button>
  </template>
  <template #uploadTip>
    <div style="color: #ccc; font-size: 12px">
      jpg/png files with a size less than 500kb
    </div>
  </template>
  <template #action="scope">
    <el-button type="primary" @click="submitForm(scope)">提交</el-button>
    <el-button @click="resetForm">重置</el-button>
  </template>
</lib-form>

// 这里以多行表单布局为例子
let options: FormOptions[] = [
  {
    type: 'row',
    rowGutter: 20,
    cols: [
      {
        type: 'input',
        value: '',
        label: '用户名',
        prop: 'username',
        placeholder: '请输入用户名',
        rules: [
          {
            required: true,
            message: '用户名不能为空',
            trigger: 'blur',
          },
          {
            min: 2,
            max: 6,
            message: '用户名在2-6位之间',
            trigger: 'blur',
          },
        ],
        attrs: {
          clearable: true,
        },
        colOption: {
          offset: 0,
          span: 12,
        },
      },
      {
        type: 'input',
        value: '',
        label: '用户名',
        prop: 'username',
        placeholder: '请输入用户名',
        rules: [
          {
            required: true,
            message: '用户名不能为空',
            trigger: 'blur',
          },
          {
            min: 2,
            max: 6,
            message: '用户名在2-6位之间',
            trigger: 'blur',
          },
        ],
        attrs: {
          clearable: true,
        },
        colOption: {
          offset: 0,
          span: 12,
        },
      },
    ],
  },
 ]