淺談vux之x-input使用以及源碼解讀
前言
近期項(xiàng)目中使用的vux中的input,以及使用自定義校驗(yàn)規(guī)則和動(dòng)態(tài)匹配錯(cuò)誤提示,有時(shí)間記錄下自己的使用經(jīng)歷和源碼分析。希望大家多多指正,留言區(qū)發(fā)表自己寶貴的建議。 詳解 列舉官方文檔中常用的幾個(gè)屬性的使用方法,代碼如下
<group ref="group"> <x-input v-model="name" class="vux-input__name" title="名字" placeholder="tell me your name" required :is-type="checkNameValid" @on-change="onValueChange"> <div slot="label" class="name__icon"> <icon type="success"></icon> </div> </x-input> </group>
官方文檔有詳細(xì)的解釋?zhuān)?required 屬性表示此選項(xiàng)為必填, is-type 可以綁定一個(gè)函數(shù),作為校驗(yàn),這個(gè)函數(shù)得返回一個(gè)對(duì)象。格式如下
checkValid(name) {
return {
valid: name === '三只萌新',
msg: '你不是萌新'
}
}
valid可以設(shè)置為你的校驗(yàn)規(guī)則,需要返回一個(gè)布爾值,msg是錯(cuò)誤的提示信息。
vux本身寫(xiě)好幾種校驗(yàn)方式,如果使用 email,china-name,china-mobile 這幾種方式直接綁定字符串即可。
solt插槽如slot="label"用于自定義title,源碼如下
<slot name="label">
<label class="weui-label"
:class="labelClass"
:style="{width: labelWidth || $parent.labelWidth || labelWidthComputed, textAlign: $parent.labelAlign, marginRight: $parent.labelMarginRight}"
v-if="title"
v-html="title"
:for="`vux-x-input-${uuid}`"></label>
<inline-desc v-if="inlineDesc">{{ inlineDesc }}</inline-desc>
</slot>
分析:class="labelClass"動(dòng)態(tài)綁定樣式以對(duì)象的形式返回一個(gè){[className]:Boolean}的格式的對(duì)象
labelClass() {
return {
'vux-cell-justify':
this.$parent.labelAlign === 'justify' ||
this.$parent.$parent.labelAlign === 'justify'
}
}
同樣的方式查看他父級(jí)是否有l(wèi)abelAlign屬性,vux-cell-justify類(lèi)名對(duì)應(yīng)的樣式?jīng)]有應(yīng)用。
使用場(chǎng)景
場(chǎng)景1
假設(shè)在一個(gè)提交頁(yè)面,當(dāng)我們提交時(shí)判斷輸入框中的值是否是符合我們的要求,如果不符合,給出錯(cuò)誤提示,如果符合提交后將輸入框中的數(shù)據(jù)清空。
需求:
如果還有停留在本頁(yè)面我們需要將上一次的數(shù)據(jù)全部清空
問(wèn)題:
我們需要初始化值,但是會(huì)發(fā)現(xiàn)如果我們?cè)O(shè)置了required后校驗(yàn)還是會(huì)觸發(fā)。如何讓數(shù)據(jù)清空并且讓校驗(yàn)也清空。
解決方法:
文檔中寫(xiě)了reset可以重置輸入框值,清除錯(cuò)誤信息
使用方式:
在x-input外層的group標(biāo)簽上綁定ref來(lái)訪(fǎng)問(wèn)子組件。因此我們可以通過(guò) this.$refs.group.$children獲取到input組件集合并且可以使用組件中定義的reset方法
如果你的項(xiàng)目中已經(jīng)安裝了vux可以通過(guò)安裝Search node_modules查找node_modules文件夾中vux安裝包路徑為 vux/src/components/x-input/index.vue 文件 reset方法源碼如下:
reset(value = '') {
this.dirty = false
this.currentValue = value
this.firstError = ''
this.valid = true
}
回到我們的業(yè)務(wù)邏輯中當(dāng)我們點(diǎn)擊提交按鈕時(shí)代碼如下
onSubmitClick() {
if (!this.isInvalid) {
this.$refs.group.$children.forEach(child => {
child.reset()
})
} else {
// 展示提示信息
this.isShowToast = true
}
本以為這樣就可以清空數(shù)據(jù)了,沒(méi)想到點(diǎn)擊按鈕時(shí)數(shù)據(jù)是清空了,但是還是有報(bào)錯(cuò)圖標(biāo)顯示。
通過(guò) vue-devtools可以看到

valid的值為false查看vux源碼查看涉及到valid代碼如下
validate() {
// ...省略與本次無(wú)關(guān)的校驗(yàn)方法
if (!this.currentValue && this.required) {
this.valid = false
this.errors.required = '必填哦'
this.getError()
return
if (typeof this.isType === 'function') {
/*
取出自定義函數(shù)中的校驗(yàn)結(jié)果 是一個(gè)Boolean
checkNameValid(name) {
return {
valid: name === '三只萌新',
msg: '你不是萌新'
}
}
*/
const validStatus = this.isType(this.currentValue)
this.valid = validStatus.valid
if (!this.valid) {
// 如果校驗(yàn)值無(wú)效將自定義校驗(yàn)的msg賦值給errors對(duì)象下的format
this.errors.format = validStatus.msg
this.forceShowError = true
this.getError()
return
} else {
// 如果校驗(yàn)值有效則將error對(duì)象下的format刪除
delete this.errors.format
}
// 如果都符合將valid賦值為有效
this.valid = true
}
}
validate函數(shù)校驗(yàn)當(dāng)前是否有值,是否為必填, 如果當(dāng)前值的校驗(yàn)方式是函數(shù),將校驗(yàn)結(jié)果賦值給valid 。如果valid是false則將自定義的msg統(tǒng)一存儲(chǔ)在errors對(duì)象下, errors是用來(lái)存儲(chǔ)不同類(lèi)型的錯(cuò)誤信息 。 然后執(zhí)行g(shù)etError函數(shù)
getError() {
let key = Object.keys(this.errors)[0]
this.firstError = this.errors[key]
console.log('firstError' + this.firstError)
}
Object.keys(this.errors)返回errors對(duì)象下的所有可枚舉屬性,并且取第一個(gè)作為鍵名,取出對(duì)于的值賦值給firstError ,firstError是提示框文字
<toast v-model="showErrorToast"
type="text"
width="auto"
:time="600">{{ firstError }}</toast>
當(dāng)點(diǎn)擊錯(cuò)誤圖標(biāo)判斷是否有firstError,shouldToastError未傳入值默認(rèn)為true,點(diǎn)擊時(shí)如果valide校驗(yàn)為錯(cuò)誤時(shí)會(huì)觸發(fā)getError函數(shù)將錯(cuò)誤提示賦值給firstError,所以會(huì)將fistError對(duì)應(yīng)的提示信息顯示出來(lái)。而圖標(biāo)的顯示與否與valid有關(guān),其中一個(gè)條件是valid為false時(shí)才會(huì)顯示。
<icon @click.native="onClickErrorIcon"
class="vux-input-icon"
type="warn"
:title="!valid ? firstError : ''"
v-show="showWarn"></icon>
shouldToastError: {
type: Boolean,
default: true
}
showWarn() {
return (
!this.novalidate &&
!this.equalWith &&
!this.valid &&
this.firstError &&
(this.touched || this.forceShowError)
)
}
onClickErrorIcon() {
if (this.shouldToastError && this.firstError) {
this.showErrorToast = true
}
this.$emit('on-click-error-icon', this.firstError)
}
分析了上面的代碼,為什么執(zhí)行了reset方法后,校驗(yàn)報(bào)錯(cuò)還是在,原因是valid依然還是false,導(dǎo)致showWarn返回值是ture,而reset中方法中明明將valid設(shè)置為true了,為什么最后結(jié)果為false。
watch:{
currentValue(newVal, oldVal) {
if (newVal && this.equalWith) {
if (newVal.length === this.equalWith.length) {
this.hasLengthEqual = true
}
this.validateEqual()
} else {
this.validate()
}
}
}
因?yàn)楸O(jiān)聽(tīng)了input綁定currentValue的值,當(dāng)reset方法執(zhí)行的時(shí)候this.currentValue = ' ' 觸發(fā)了變動(dòng)執(zhí)行validate方法,導(dǎo)致再次給this.valid賦值false。
該如何解決這個(gè)問(wèn)題,問(wèn)題發(fā)生的原因是currentValue發(fā)生變化導(dǎo)致觸發(fā)validate方法校驗(yàn),所以我們只要當(dāng)執(zhí)行reset方法后不觸發(fā)currentValue改變就可以不觸發(fā)validate方法校驗(yàn)
方法一:
onSubmitClick() {
this.$refs.group.$children.forEach(child => {
// 這次reset是將currentValue全部置為""
child.reset()
})
this.$nextTick(() => {
// 當(dāng)所以input的值都置為空后在此執(zhí)行reset方法,這次前后currentValue沒(méi)有發(fā)生變化不會(huì)觸發(fā)validate校驗(yàn)所以valide為true不會(huì)導(dǎo)致圖標(biāo)出現(xiàn)
this.$refs.group.$children.forEach(child => {
child.reset()
})
})
}
方法二: 其實(shí)想做的就是在reset方法執(zhí)行之前將currentValue置為空
created(){
this.currentValue =
this.value === undefined || this.value === null
? ''
: this.mask ? this.maskValue(this.value) : this.value
},
props:{
value: [String, Number]
},
watch:{
value(val) {
this.currentValue = val
}
}
可以通過(guò)傳入value來(lái)改變currentValue的值,將v-model="name"綁定值的方式改為:value="name"
onSubmitClick() {
this.name = ''
this.$nextTick(() => {
this.$refs.group.$children.forEach(child => {
child.reset()
})
})
}
場(chǎng)景2
當(dāng)我們點(diǎn)擊提交時(shí),如果有校驗(yàn)選項(xiàng)不符合規(guī)則能提示相匹配的警告
data(){
return {
message: '還未填寫(xiě)信息'
}
}
將message提示信息初始值設(shè)置為還未填寫(xiě)信息,當(dāng)我們未進(jìn)行填寫(xiě)信息的時(shí)候點(diǎn)擊提交顯示。然后使用on-change函數(shù)綁定校驗(yàn)規(guī)則,實(shí)時(shí)更新message對(duì)應(yīng)的提示語(yǔ),業(yè)務(wù)邏輯如下:
onValueChange() {
// 多次使用賦值給變量
const children = this.$refs.group.$children
let statusList = []
// 篩選出有值的,作為是否全部未填的判斷依據(jù) 如果length小于1則還沒(méi)填寫(xiě)任何內(nèi)容
statusList = children.filter(item => {
return item.currentValue
})
if (statusList.length < 1) {
this.message = '還未填寫(xiě)信息'
return
}
// 找到第一個(gè)沒(méi)有值的那一項(xiàng),如果都有則返回undefined
const firstInvalid = children.find(item => {
return !item.valid
})
if (firstInvalid !== undefined) {
this.message = `請(qǐng)?zhí)顚?xiě)正確的${firstInvalid.title}`
}
// 顯示的將是否有效賦值給valid增加代碼可讀性
this.valid = Boolean(firstInvalid)
}
github:代碼地址
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
記一次Vue中$route序列號(hào)報(bào)錯(cuò)
本文主要介紹了記一次Vue中$route序列號(hào)報(bào)錯(cuò),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
如何解決npm i下載依賴(lài)的時(shí)候出現(xiàn)某依賴(lài)版本沖突
這篇文章主要介紹了如何解決npm i 下載依賴(lài)的時(shí)候出現(xiàn)某依賴(lài)版本沖突問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-03-03
vue項(xiàng)目中引入noVNC遠(yuǎn)程桌面的方法
下面小編就為大家分享一篇vue項(xiàng)目中引入noVNC遠(yuǎn)程桌面的方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-03-03
Vue實(shí)現(xiàn)側(cè)邊菜單欄手風(fēng)琴效果實(shí)例代碼
本文通過(guò)一段簡(jiǎn)單的代碼給大家介紹了基于純vue實(shí)現(xiàn)側(cè)邊菜單欄手風(fēng)琴效果,代碼很簡(jiǎn)單,感興趣的朋友跟隨腳本之家小編一起看看吧2018-05-05
vue登錄以及權(quán)限驗(yàn)證相關(guān)的實(shí)現(xiàn)
這篇文章主要介紹了vue登錄以及權(quán)限驗(yàn)證相關(guān)的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-10-10
vue3+vite使用History路由模式打包部署項(xiàng)目的步驟及注意事項(xiàng)
這篇文章主要介紹了vue3+vite使用History路由模式打包部署項(xiàng)目的步驟及注意事項(xiàng),配置過(guò)程包括在Vue項(xiàng)目中設(shè)置路由模式、調(diào)整打包配置以及Nginx服務(wù)器的配置,正確的部署配置能夠確保應(yīng)用順利運(yùn)行,提升用戶(hù)體驗(yàn),需要的朋友可以參考下2024-10-10
vue如何利用store實(shí)現(xiàn)兩個(gè)平行組件間的傳值
這篇文章主要介紹了vue如何利用store實(shí)現(xiàn)兩個(gè)平行組件間的傳值,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-04-04

