vue3 + antd + a-form 动态数组表单校验

业务场景

一个表单提交不同的类型用户,可以添加多个用户,页面如下:

image.png

最终的代码在最后,可以滑到最后

表单结构

需要提交表单的表单结构,分别有主播和员工的两个列表,如下:

interface PersonItem {
  username: string
  label: string
}

interface IForm {
  anchor: PersonItem[] // 主播列表
  staff: PersonItem[] // 员工列表
  [key: string]: any // 这里是为了阻止使用中括号取对象的值失TS报错
}
const form = reactive<IForm>({
  anchor: [{ username: '', label: '' }],
  staff: [{ username: '', label: '' }]
})

模板结构

  • 通过section模块区分用户类型 ,分别用v-for遍历不同用户类型列表。
  • 在a-form-item中添加name属性,结构为用户类型-下标-用户属性字段。这是最关键的一点,在自定义校验回调函数中用到。
    具体结构如下:
<template>
  <a-form ref="formRef" :model="form">
    <div class="section">
      <h3>主播</h3>
      <div v-for="(item, index) in form.anchor" class="row">
        <a-form-item label="姓名" :name="`anchor-${index}-username`" :rules="rules.username">
          <a-input v-model:value="item.username"></a-input>
        </a-form-item>
        <a-form-item label="标签" :name="`anchor-${index}-label`" :rules="rules.label" style="margin-left: 20px;">
          <a-input v-model:value="item.label"></a-input>
        </a-form-item>
        <DeleteOutlined class="row-delete" @click="removePerson('anchor', index)" />
      </div>
      <a-button type="text" @click="addPerson('anchor')">+ 添加</a-button>
    </div>
    <div class="section">
      <h3>员工</h3>
      <div v-for="(item, index) in form.staff" class="row">
        <a-form-item label="姓名" :name="`staff-${index}-username`" :rules="rules.username">
          <a-input v-model:value="item.username"></a-input>
        </a-form-item>
        <a-form-item label="标签" :name="`staff-${index}-label`" :rules="rules.label" style="margin-left: 20px;">
          <a-input v-model:value="item.label"></a-input>
        </a-form-item>
        <DeleteOutlined class="row-delete" @click="removePerson('staff', index)" />
      </div>
      <a-button type="text" @click="addPerson('staff')">+ 添加</a-button>
    </div>
    <a-form-item>
      <a-button @click="onCancel">取消</a-button>
      <a-button type="primary" @click="onSubmit">提交</a-button>
    </a-form-item>
  </a-form>
</template>

自定义校验规则

在a-form自定义检验函数中,分别返回rule、value、callback。
rule:就是校验的配置规则,在这个对象中有个field属性,这个属性记录了模板中a-form-item中绑定的name值。
value: 对应表单属性的值。但是在数组表单中获取不到,所以我们需要通过rule的field获取对应的值。
callback:这个回调函数是必须调用的,否则校验自定义校验函数没有结果。如果不调用,也可以返回Promise。在本例中使用的返回Promise的方式。

通过rule的field属性,获取到对应的属性,取到值在进行校验判断。具体代码如下:

const inputValidator = (rule: Rule1) => {
  const [cellKey, index, prop] = rule.field.split('-')
  if ((form[cellKey][index][prop] ?? '') === '') {
    return Promise.reject(new Error(rule.message as unknown as string))
  } else {
    return Promise.resolve()
  }
}

最终代码

<script setup lang="ts">
import { DeleteOutlined } from '@ant-design/icons-vue';
import { FormInstance, message } from 'ant-design-vue';
import { Rule } from 'ant-design-vue/es/form';
import { reactive, ref } from 'vue';

interface PersonItem {
  username: string
  label: string
}

interface IForm {
  anchor: PersonItem[],
  staff: PersonItem[],
  [key: string]: any
}
const form = reactive<IForm>({
  anchor: [{ username: '', label: '' }],
  staff: [{ username: '', label: '' }]
})

type Rule1 = Rule & {
  field: string
}

const inputValidator = (rule: Rule1) => {
  const [cellKey, index, prop] = rule.field.split('-')
  if ((form[cellKey][index][prop] ?? '') === '') {
    return Promise.reject(new Error(rule.message as unknown as string))
  } else {
    return Promise.resolve()
  }
}


const rules = {
  username: [{ required: true, validator: inputValidator, message: '姓名不能为空' }],
  label: [{ required: true, validator: inputValidator, message: '标签不能为空' }]
}

const formRef = ref<FormInstance | null>(null)

const onSubmit = () => {
  formRef.value?.validate().then(() => {
    message.success('提交成功')
  }).catch(() => {
    console.log('表单校验失败')
  })
}

const onCancel = () => {
  formRef.value?.resetFields()
}

const addPerson = (type: string) => {
  const person: PersonItem = {username: '', label: ''}
  form[type].push(person)
}

const removePerson = (type: string, index:number) => {
  const personList = form[type]
  if (personList.length === 1) return
  personList.splice(index, 1)
}
</script>

<template>
  <a-form ref="formRef" :model="form">
    <div class="section">
      <h3>主播</h3>
      <div v-for="(item, index) in form.anchor" class="row">
        <a-form-item label="姓名" :name="`anchor-${index}-username`" :rules="rules.username">
          <a-input v-model:value="item.username"></a-input>
        </a-form-item>
        <a-form-item label="标签" :name="`anchor-${index}-label`" :rules="rules.label" style="margin-left: 20px;">
          <a-input v-model:value="item.label"></a-input>
        </a-form-item>
        <DeleteOutlined class="row-delete" @click="removePerson('anchor', index)" />
      </div>
      <a-button type="text" @click="addPerson('anchor')">+ 添加</a-button>
    </div>
    <div class="section">
      <h3>员工</h3>
      <div v-for="(item, index) in form.staff" class="row">
        <a-form-item label="姓名" :name="`staff-${index}-username`" :rules="rules.username">
          <a-input v-model:value="item.username"></a-input>
        </a-form-item>
        <a-form-item label="标签" :name="`staff-${index}-label`" :rules="rules.label" style="margin-left: 20px;">
          <a-input v-model:value="item.label"></a-input>
        </a-form-item>
        <DeleteOutlined class="row-delete" @click="removePerson('staff', index)" />
      </div>
      <a-button type="text" @click="addPerson('staff')">+ 添加</a-button>
    </div>
    <a-form-item>
      <a-button @click="onCancel">取消</a-button>
      <a-button type="primary" @click="onSubmit">提交</a-button>
    </a-form-item>
  </a-form>
</template>

<style lang="scss" scoped>
.row {
  display: flex;

  .row-delete {
    margin-top: 10px;
    margin-left: 10px;
  }
}
</style>

效果

image.png

总结

  • 需要给a-form-item绑定name属性,用于记录需要校验的表单属性。
  • 通过自定义校验函数的rule的field属性获取到要校验的属性,对其进行校验判断。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,634评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,951评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,427评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,770评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,835评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,799评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,768评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,544评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,979评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,121评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,756评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2 352