Vue3表单组件el-form校验规则rules属性
一、前言
在使用 Element UI (现在称为 Element Plus) 的表单组件 el-form 时，rules 属性用于定义表单项的校验规则。这些规则可以帮助你确保用户输入的数据符合预期的格式和要求。
1.基本用法
rules 是一个对象，其中每个键对应一个表单项的字段名，值是一个或多个校验规则。常见的校验规则包括必填、数据类型、最小长度、最大长度、自定义校验等。
2.示例代码
以下是一个包含多个校验规则的示例：
<template>
<el-form :model="formData" :rules="rules" ref="form">
<el-form-item label="用户名" prop="username">
<el-input v-model="formData.username"></el-input>
</el-form-item>
<el-form-item label="邮箱" prop="email">
<el-input v-model="formData.email"></el-input>
</el-form-item>
<el-form-item label="密码" prop="password">
<el-input type="password" v-model="formData.password"></el-input>
</el-form-item>
<el-button type="primary" @click="submitForm">提交</el-button>
</el-form>
</template>
<script>
export default {
data() {
return {
formData: {
username: '',
email: '',
password: ''
},
rules: {
username: [
{ required: true, message: '用户名不能为空', trigger: 'blur' },
{ min: 3, max: 15, message: '用户名长度应在3到15个字符之间', trigger: 'blur' }
],
email: [
{ required: true, message: '邮箱不能为空', trigger: 'blur' },
{ type: 'email', message: '请输入有效的邮箱地址', trigger: 'blur' }
],
password: [
{ required: true, message: '密码不能为空', trigger: 'blur' },
{ min: 6, max: 20, message: '密码长度应在6到20个字符之间', trigger: 'blur' }
]
}
};
},
methods: {
submitForm() {
this.$refs.form.validate((valid) => {
if (valid) {
console.log('表单提交成功');
} else {
console.log('表单校验失败');
return false;
}
});
}
}
};
</script>
3.校验规则详解
required: 表示该字段是否为必填项。message: 校验失败时显示的错误提示信息。trigger: 触发校验的时机，常见的值有'blur'和'change'。type: 指定校验的数据类型，如'string'、'number'、'email'、'url'等。min和max: 指定字符串长度或数值的范围，只在type为'string'或'number'时有效。- 自定义校验函数: 可以通过
validator属性定义一个自定义的校验函数。
4.自定义校验函数示例
有时候内置的校验规则无法满足需求，这时可以使用自定义校验函数：
rules: {
password: [
{ required: true, message: '密码不能为空', trigger: 'blur' },
{ min: 6, max: 20, message: '密码长度应在6到20个字符之间', trigger: 'blur' },
{ validator: validatePasswordStrength, trigger: 'blur' }
]
}
function validatePasswordStrength(rule, value, callback) {
if (!/\d/.test(value)) {
callback(new Error('密码必须包含至少一个数字'));
} else if (!/[a-zA-Z]/.test(value)) {
callback(new Error('密码必须包含至少一个字母'));
} else {
callback();
}
}
在这个示例中，validatePasswordStrength 函数被用作自定义校验函数，确保密码至少包含一个数字和一个字母。
二、总结
通过合理配置 el-form 中的 rules 属性，可以实现复杂的表单校验逻辑，提升表单的易用性和数据的可靠性。根据具体需求选择合适的校验规则和触发时机，是实现高质量表单的关键。