首页 > 网络编程 > JavaScript > javascript类库 > vue.js > Vue3 el-form校验规则rules属性

Vue3表单组件el-form校验规则rules属性示例详解

2024-08-17 09:19:07 作者：和烨

在el-form中正确使用rules校验是非常重要的,rules使用不当容易出现规则不生效、规则一直被触发等各种现象,这篇文章主要给大家介绍了关于Vue3表单组件el-form校验规则rules属性的相关资料,需要的朋友可以参考下

前言

在使用 Element UI (现在称为 Element Plus) 的表单组件 el-form 时，rules 属性用于定义表单项的校验规则。这些规则可以帮助你确保用户输入的数据符合预期的格式和要求。

基本用法

rules 是一个对象，其中每个键对应一个表单项的字段名，值是一个或多个校验规则。常见的校验规则包括必填、数据类型、最小长度、最大长度、自定义校验等。

示例代码

以下是一个包含多个校验规则的示例：

<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>

校验规则详解

required: 表示该字段是否为必填项。
message: 校验失败时显示的错误提示信息。
trigger: 触发校验的时机，常见的值有 'blur' 和 'change'。
type: 指定校验的数据类型，如 'string'、'number'、'email'、'url' 等。
min 和 max: 指定字符串长度或数值的范围，只在 type 为 'string' 或 'number' 时有效。
自定义校验函数: 可以通过 validator 属性定义一个自定义的校验函数。

自定义校验函数示例

有时候内置的校验规则无法满足需求，这时可以使用自定义校验函数：

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 函数被用作自定义校验函数，确保密码至少包含一个数字和一个字母。

附：更多自定义的校验

例如：再次确认密码的，在data中定义一个const 常量，在rules中引入

1. 在form表单中加入rules,并加上prop=‘’

<el-form ref="form" :model="form" :rules="rules" size="small" label-width="88px">
	<el-form-item label="确认密码" prop="confirmPass">
        <el-input v-model="form.confirmPass" type="password" auto-complete="on" style="width: 370px;" />
    </el-form-item>
...
</el-form>

2.在data中定义一个const 常量

data(){
	// 定义规则 (rule, value, callback) 
	const confirmPass = (rule, value, callback) => {
      if (value) {
        if (this.form.newPass !== value) {
          callback(new Error('两次输入的密码不一致'))
        } else {
          callback()
        }
      } else {
        callback(new Error('请再次输入密码'))
      }
    }
 ...
}

3. 在rules中引入自定义的规则confirmPass

rules:{
	oldPass: [
       { required: true, message: '请输入旧密码', trigger: 'blur' }
     ],
     newPass: [
       { required: true, message: '请输入新密码', trigger: 'blur' },
       { min: 6, max: 20, message: '长度在 6 到 20 个字符', trigger: 'blur' }
     ],
	confirmPass: [
       { required: true, validator: confirmPass, trigger: 'blur' }
   ]
...
}

总结

通过合理配置 el-form 中的 rules 属性，可以实现复杂的表单校验逻辑，提升表单的易用性和数据的可靠性。根据具体需求选择合适的校验规则和触发时机，是实现高质量表单的关键。

到此这篇关于Vue3表单组件el-form校验规则rules属性的文章就介绍到这了,更多相关Vue3 el-form校验规则rules属性内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！