Vee-validate 父元件獲取子元件表單校驗結果

givebest發表於2019-05-18

vee-validate 是為 Vue.js 量身打造的表單校驗框架,允許您校驗輸入的內容並顯示對應的錯誤提示資訊。它內建了很多常見的校驗規則,可以組合使用多種校驗規則,大部分場景只需要配置就能實現開箱即用,還支援自定義正規表示式。而且支援 40 多種語言,對本地化、多語言支援非常友好。

國內餓了麼團隊開源專案 Element UI 就用到了 vee-validate

vee-validate官網:https://baianat.github.io/vee-validate/

使用方法

可檢視官網文件(https://baianat.github.io/vee-validate/)或者檢視這一篇文章(https://blog.givebest.cn/javascript/2019/04/20/vue.js-nuxt.js-use-vee-validate.html)。

元件內使用 Vee-validate

子元件

<template>
  <div>
    <input
      placeholder="請輸入姓名"
      v-model="username"
      name="username"
      v-validate="'required'"
      :error-message="errors.first('username')"
    />
  </div>
</template>

<script>
export default {
  name: "Username",
  data() {
    return {
      username: ''
    }
  },
  methods: {
    // 表單校驗
    validateForm() {
      return this.$validator.validateAll();
    },
  }
};
</script>

父元件

<template>
  <div>
    <Username ref="usernameComponent" />
    <Password ref="passwordComponent" />

    <div>
      <button @click="onSubmit">提交校驗</button>
    </div>
  </div>
</template>

<script>
import Username from "~/components/username.vue"
import Password from "~/components/password.vue"

export default {
  components: {
    Username,
    Password
  },
  data() {
    return {}
  },
  methods: {
    onSubmit (e) {
      e.preventDefault()  // 阻止預設事件

      // 父元件觸發子元件校驗,並通過 Promise 返回值
      let vf1 = this.$refs.usernameComponent.validateForm()
      let vf2 = this.$refs.passwordComponent.validateForm()

      // 提交表單前,校驗所有子元件,全部通過才允許下面操作
      Promise.all([vf1, vf2]).then(result => {
        // 有一個元件未通過,就提示錯誤資訊
        if (result.indexOf(false) > -1) {
          console.log("全部校驗未通過")
          return
        }

        // 校驗全部通過處理
        console.log("全部校驗通過")
      })
    },
  }
};
</script>

總結

其實元件內使用 Vee-validate 校驗很方便,主要問題可能是父元件怎麼觸發子元件內的校驗,並獲取校驗結果。這裡用到 Vue.js 裡的 ref 特性,給子元件賦值一個 ID 引用,然後就可以使用 this.$refs.childComponent 獲得子元件例項引用,再分別調起子元件寫好的校驗方法,如:

/**
父元件觸發子元件校驗,並通過 Promise 返回值
*/
let vf1 = this.$refs.usernameComponent.validateForm() // 父元件呼叫 usernameComponent 元件裡的 validateForm 方法
let vf2 = this.$refs.passwordComponent.validateForm() // 父元件呼叫 passwordComponent 元件裡的 validateForm 方法

然後通過 Promise.all 獲取全部子元件校驗結果後,再根據結果來判斷,是否全部通過,分別做出不同處理。

// 提交表單前,校驗所有子元件,全部通過才允許下面操作
Promise.all([vf1, vf2]).then(result => {
  // 有一個元件未通過,就提示錯誤資訊
  if (result.indexOf(false) > -1) {
    console.log("全部校驗未通過")
    return
  }

  // 校驗全部通過處理
  console.log("全部校驗通過")
})

轉載請註明出處: https://blog.givebest.cn/javascript/2019/05/18/vee-validate-get-subcomponent-verification-results.html

相關文章