實務上常見的需求,但 VeeValidate 沒有支援

實務上在驗證欄位時,不單單只是顯示錯誤訊息而已,實務上可能會需要 alert() 顯示錯誤訊息,還必須要將 Focus 回到錯誤欄位,VeeValidate 內建並沒有支援此功能,必須自行實作。

Version


Vue 2.5.17
VeeValidate 2.1.2

Scenario


focus000

  1. 按下 Submit 後使用 alert() 顯示錯誤訊息。

focus001

  1. 將 focus 回到錯誤的欄位上

VeeValidate


demo.vue

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<template>
<div>
<div>
<input v-model="customEmail"
v-validate="'required|custom-email'"
name="customEmailAddress"
type="text">

</div>
<div>
<span>{{ errors.first('customEmailAddress') }}</span>
</div>
<div>
<button @click="onSubmit">Submit</button>
</div>
</div>
</template>

<script>
import validator from '../validators/email';

validator();

/** data */
const data = function() {
return {
email: '',
customEmail: '',
};
};

/** methods */
const onSubmit = function() {
const hasError = this.errors.items.length;
const showFirstErrorMessage = () => alert(this.errors.items[0].msg);
const name = this.errors.items[0].field;
const setFocusOnErrorComponent = () => this.$root.$el.querySelector(`[name=${name}]`).focus();

if (hasError) {
showFirstErrorMessage();
setFocusOnErrorComponent();
return;
}

alert('no error');
};

const methods = {
onSubmit,
};

export default {
name: 'demo',
data,
methods,
};
</script>

33 行

1
const hasError = this.errors.items.length;

VeeValidate 的 errors object 會在 Vue Instance 下,而所有錯誤訊息都在 items array 下。

由於 ECMAScript 的 Truthy Value 特性,因此可用 length 作為 true 判斷。

34 行

1
const showFirstErrorMessage = () => alert(this.errors.items[0].msg);

其中第一個錯誤訊息,就是放在 items[0].msg property。

35 行

1
2
const name = this.errors.items[0].field;
const setFocusOnErrorComponent = () => this.$root.$el.querySelector(`[name=${name}]`).focus();

除了顯示錯誤訊息外,我們還希望將 focus 回到錯誤欄位。

由於 VeeValidate 都要使用 HTML 的 name,因此我們可利用此特性抓到錯誤欄位。

使用 items[0].field 抓到第一個錯誤欄位的 name

利用 this.$root.$elquerySelect() 抓到該欄位,然後呼叫 focus()

38 行

1
2
3
4
5
if (hasError) {
showFirstErrorMessage();
setFocusOnErrorComponent();
return;
}

若有任何 VeeValidate 驗證錯誤,使用 alert() 顯示錯誤訊息,並將 focus 回到錯誤欄位,一氣呵成。

Conclusion


  • VeeValidate 並沒有內建此功能,必須使用一些小技巧才能達成

Sample Code


完整的範例可以在我的 GitHub 上找到

2018-11-20