BuildAdmin

# 表单验证

我们基于el-form的表单验证，额外的预设了一些列常用表单验证函数。

# 快速创建验证规则

您可以直接使用buildValidatorData()函数快速的构建表单验证规则，该函数接受一个object。

/**
 * 构建表单验证规则
 * @param {object} paramsObj 参数对象
 */
buildValidatorData(paramsObj)

# paramsObj 可用属性

参数名 注释
name 规则名，可用规则
message 验证错误消息
title 验证项标题仅常用规则支持此属性
trigger 验证触发方式：change、blur

# 示例代码

<template>
    <!-- 一定要设置好`rules`和`model`属性，以及formItem的`prop`属性 -->
    <el-form ref="formRef" :rules="rules" :model="ruleForm" label-width="120px">
        <FormItem label="变量名" type="string" v-model="ruleForm.name" prop="name" />
        <FormItem label="变量分组" type="select" v-model="ruleForm.group" prop="group" :data="{ content: {a: '分组1', b: '分组2'} }" />
        <FormItem label="描述" type="string" v-model="ruleForm.desc" prop="desc" />
        <el-button v-blur @click="onSubmit(formRef)" type="primary"> 提交 </el-button>
    </el-form>
</template>

<script setup lang="ts">
import { reactive, ref } from 'vue'
import FormItem from '/@/components/formItem/index.vue'
import type { FormInstance, FormRules } from 'element-plus'
import { buildValidatorData } from '/@/utils/validate';

const formRef = ref<FormInstance>()
const ruleForm = reactive({
    name: '',
    group: '',
    desc: '',
})

// 此处直接使用 buildValidatorData 生成了表单验证规则
const rules = reactive<FormRules>({
    name: [buildValidatorData({ name: 'required', title: '变量名' }), buildValidatorData({ name: 'varName' })],
    group: [buildValidatorData({ name: 'required', trigger: 'change', message: '请选择分组' })],
})

const onSubmit = (formEl: FormInstance | undefined) => {
    if (!formEl) return
    formEl.validate((valid) => {
        if (valid) {
            // 验证通过
        }
    })
}
</script>

# 可用验证规则

可以通过buildValidatorData()创建的验证规则。

# 常用规则

常用规则可用使用title属性

buildValidatorData({ name: 'required', title: '必填' }) // 请输入必填
buildValidatorData({ name: 'required', message: '标题是必填的', trigger: 'change' }) // 标题是必填的

buildValidatorData({ name: 'number', title: '数字' }) // 请输入正确的数字
buildValidatorData({ name: 'number', message: '您输入的数字不正确', trigger: 'change' }) // 您输入的数字不正确

buildValidatorData({ name: 'integer', title: '整数' }) // 请输入正确的整数
buildValidatorData({ name: 'float', title: '浮点数' }) // 请输入正确的浮点数
buildValidatorData({ name: 'date', title: '日期'}) // 请输入正确的日期
buildValidatorData({ name: 'url', title: 'URL' }) // 请输入正确的URL
buildValidatorData({ name: 'email', title: 'Email' }) // 请输入正确的Email

# 预设验证规则

预设规则不可以使用title，请使用完整的message代替

buildValidatorData({ name: 'mobile', message: '请输入正确的手机号' }) // 请输入正确的手机号
buildValidatorData({ name: 'account', message: '请输入正确的账户', trigger: 'change' }) // 请输入正确的账户
buildValidatorData({ name: 'password', message: '请输入正确的密码', trigger: 'change' }) // 请输入正确的密码
buildValidatorData({ name: 'varName', message: '请输入正确的变量名称' }) // 请输入正确的名称
buildValidatorData({ name: 'editorRequired', message: '内容不能为空' }) // 内容不能为空

← 内置指令 →