Vuelidate:简单轻量的Vue.js验证库
Vuelidate是一个专为Vue.js 2.x和3.0设计的模型基础验证库,其核心理念是提供简洁且易于使用的验证解决方案。Vuelidate文档提供了详细的使用指南,帮助您快速上手。
安装与使用
使用Vuelidate时,建议配合@vuelidate/validators
一起使用,以便获取一系列常用的验证规则。支持Vue 3.0和2.x版本,安装方法如下:
npm install @vuelidate/core @vuelidate/validators
# 或者
yarn add @vuelidate/core @vuelidate/validators
使用选项API
在选项API中,只需从setup
返回一个空的Vuelidate实例,然后将验证状态存放在data
里,规则定义在validations
函数中:
// ...
data: () => ({
form: {
name: '',
email: ''
}
}),
setup: () => ({ v$: useVuelidate() }),
validations () {
return {
form: {
name: { required },
email: { required, email }
}
}
}
// ...
使用Composition API
对于Composition API,您需要提供一个状态对象和一组验证规则给useVuelidate
:
import { reactive } from 'vue';
import { useVuelidate } from '@vuelidate/core';
import { email, required } from '@vuelidate/validators';
// ...
setup () {
const state = reactive({
name: '',
emailAddress: ''
});
const rules = {
name: { required },
emailAddress: { required, email }
};
const v$ = useVuelidate(rules, state);
return { state, v$ };
}
// ...
全局配置
可以通过useVuelidate
的第三个参数或validationsConfig
来设置全局配置,如自动脏检查($autoDirty
)、懒加载($lazy
)等。更多详细信息,请参阅Vuelidate配置文档。
验证对象v$
v$
对象提供了一系列属性用于管理验证状态,如:
// ...
$dirty: false, // 只有当$dirty为true时,验证才会运行
$touch: Function, // 将$dirty设为true
$reset: Function, // 将$dirty设为false
$errors: [], // 存储当前错误对象
$error: false, // 如果验证未通过,则为true
$invalid: false, // 同上,为了兼容性
// 更多属性,请查看文档
// ...
验证规则默认启用
在Vuelidate 2中,验证默认开启,这意味着初始化时就会调用验证器,但只有字段变脏($touch()
被调用或通过$model
)后,错误才被视为活跃状态。若需延迟验证,可传递{ $lazy: true }
配置。
应用场景
Vuelidate适用于各种表单验证场景,包括但不限于网页登录注册、购物车结算、个人资料编辑等。您可以轻松地控制何时触发验证,何时重置状态,并直观地展示错误信息。
特点
- 轻量级 - 无需额外的依赖,只为Vue.js量身定制。
- 易用性 - 简洁的API设计使得添加和管理验证规则变得直观。
- 灵活 - 支持Options API和Composition API,以及自定义验证规则。
- 性能优化 - 提供懒加载选项,仅在需要时进行验证,减少不必要的计算。
总的来说,Vuelidate是一个强大的工具,可以帮助开发者在构建Vue.js应用时轻松处理数据验证。无论是初学者还是经验丰富的开发者,都能从它的简洁和强大中受益。立即尝试Vuelidate,提升您的验证体验!