Vue-Ant Design Vue-普通及自定义校验实例

Z时代
2024-01-10
分类：IT

这段时间在使用Ant Design Vue进行项目的前端部分开发，进行一个记录，分享…

Ant Design Vue

Ant Design Vue是 Ant Design 3.X 的 Vue 实现，开发和服务于企业级后台产品。在GitHub上可以找到几个Ant Design的Vue组件。不过相比较而言，Ant Design Vue更胜一筹。Ant Design Vue共享Ant Design of React设计工具体系，实现了所有Ant Design of React的组件，支持现代浏览器和 IE9 及以上（需要 polyfills）。可以让熟悉Ant Design的在使用Vue时，很容易的上手。

nodejs，npm包括Ant Design Vue安装什么的就不说了，可以百度，之后有时间我会写一篇关于这一套东西的安装教程，关于Ant Design Vue，可以直接查看官方文档：https://vue.ant.design

下面说一下关于Ant Design Vue中的表单校验及自定义校验。

自定义校验

先给一张Ant Design Vue得form表单中不同类型的校验场景图，看看是否有你需要的：

官方提供了 validateStatus, help ,hasFeedback 等属性，你可以不需要使用 Form.create 和 getFieldDecorator，自己定义校验的时机和内容。

validateStatus: 校验状态，可选 ‘success', ‘warning', ‘error', ‘validating'。

hasFeedback：用于给输入框添加反馈图标。

help：设置校验文案。

说明一点：当你使用Ant Design Vue的使用，经过 Form.create 包装的组件将会自带 this.form 属性

this.form 提供的关于校验的API如下：

方法	说明	类型
validateFields	校验并获取一组输入域的值与 Error，若 fieldNames 参数为空，则校验全部组件	Function([fieldNames: string[]], [options: object], callback: Function(errors, values))

然后看下Form.Item的参数设置（主要看关于校验的）：

参数	说明	类型	默认值
extra	额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。	string/slot
hasFeedback	配合 validateStatus 属性使用，展示校验状态图标，建议只配合 Input 组件使用。	boolean	false
help	提示信息，如不设置，则会根据校验规则自动生成	string/slot
validateStatus	校验状态，如不设置，则会根据校验规则自动生成，可选：‘success' ‘warning' ‘error' ‘validating'	string

最后是校验规则设置:

相关的api及参数设置介绍完乐，下面上实例

实例

写一个简单的例子

form表单代码：


<a-form style="max-width: 500px; margin: 40px auto 0;" @submit="handleSubmit" :form="form">
<a-form-item
label="密码"
:labelCol="{span: 5}"
:wrapperCol="{span: 19}"
class="stepFormText"
hasFeedback
>
<a-input
v-decorator="[
'password',
{rules: [{ required: true, message: '请输入密码' },{validator: handlePass}]}
]"
name="password"
/>
</a-form-item>
<a-form-item
label="确认密码"
:labelCol="{span: 5}"
:wrapperCol="{span: 19}"
class="stepFormText"
hasFeedback
>
<a-input
v-decorator="[
'confirm_password',
{rules: [{ required: true, message: '请输入确认密码' },{validator: handleConfirmPass}]}
]"
name="confirm_password"
/>
</a-form-item>
<a-form-item :wrapperCol="{span: 19, offset: 5}">
<a-button :loading="loading" type="primary" htmlType="submit">提交</a-button>
</a-form-item>
</a-form>

进行一下说明，以确认密码的校验为例：


<a-input
     v-decorator="[
     'confirm_password',
     {rules: [{ required: true, message: '请输入确认密码' },{validator: handleConfirmPass}]}
    ]"
     name="confirm_password"
   />

rules中为一个数组，每一项就是一个校验规则，第一项规则容易理解，但是{validator: handleConfirmPass}是什么的，我们通过上面的校验规则设置（红框处）可以发现，这是当你设置自定义校验的时候需要这么写。注意：callback 必须被调用。

handleConfirmPass 其实就是自定义校验的校验方法。

上js代码:


<script>
export default {
 data () {
  return {
   labelCol: {
    xs: { span: 24 },
    sm: { span: 7 }
   },
   wrapperCol: {
    xs: { span: 24 },
    sm: { span: 13 }
   },
   password: '',
   // form
   form: this.$form.createForm(this)
  }
 },
 methods: {
  handlePass(rule,value,callback){
   this.password = value
   callback()
  },
  handleConfirmPass(rule,value, callback){
   if (this.password && this.password !== value) {
    callback('两次密码输入不一致！')
   }
   // Note: 必须总是返回一个 callback，否则 validateFieldsAndScroll 无法响应
   callback()
  },
  handleSubmit (e) {
   e.preventDefault()
   this.form.validateFields((err, values) => {
    if (!err) {
     console.log(values)
    }
   })
  }
 }
}
</script>