Vuerify 是一款簡單輕量的 Vue 數據校驗插件。它內置基礎校驗規則與錯誤提示,支持自定義規則(可為正則、函數或字符串),規則既可全局註冊也可在組件內註冊。插件會為 vm 添加 $vuerify 對象,並 watch 數據自動校驗,若有錯誤則存入 vm.$vuerify.$errors。
npm i vuerify -S
安裝並註冊插件,同時可傳入自定義規則:
import Vue from 'vue' import Vuerify from 'vuerify' Vue.use(Vuerify, /* 添加自定義規則 */)
自定義規則的 test 可以是正則或函數:
{
required: {
test: /\S+$/,
message: '必填項'
}
}
在組件內註冊規則:
{
data () {
return {
username: '',
password: ''
}
},
vuerify: {
username: {
test: /\w{4,}/, // 自定義規則,可為函數、正則或全局註冊規則
message: '至少 4 位字符'
},
password: 'required' // 使用全局註冊的規則
}
}
$vuerify 對象包含以下屬性:
$errors:數據校驗失敗的錯誤信息對象,例如 username 校驗失敗會返回 { username: '至少 4 位字符' }。invalid:是否存在校驗失敗的字段(Boolean)。valid:是否不存在校驗失敗的字段(Boolean)。check:檢查指定字段,傳入數組並返回 Boolean。clear:清空錯誤列表。該指令可在表單組件觸發 blur 事件時驗證數據,並為組件設置類名(默認為 .vuerify-invalid)。它可用於 input 等原生組件,也可用於自封裝的組件。提供針對不同 Vue 版本的兩個包:
# Vue 1.x npm v-vuerify -S # Vue 2.0 npm v-vuerify-next -S
用法:
import Vue from 'vue' import VuerifyDirective from 'v-vuerify' // Vue1.x // import VuerifyDirective from 'v-vuerify-next' // Vue2.0 Vue.use(VuerifyDirective)
<input v-model="username" v-vuerify="'username'"> <x-input :value.sync="password" v-vuerify="'password'"></x-input>
可通過 vuerify-invalid-class 自定義校驗失敗時的類名:
<input v-model="username" v-vuerify="'username'" vuerify-invalid-class="error">
此外,若 vuerify 是在父組件註冊的,需使用 parent 修飾符,讓指令能從父組件獲取對應的 $vuerify。插件還提供了 vuerify-invalid 與 vuerify-valid 兩個事件。項目地址:https://github.com/QingWei-Li/vuerify