快捷導(dǎo)航

使用el-form之表單校驗(yàn)自動(dòng)定位到報(bào)錯(cuò)位置問題

更新時(shí)間：2023年05月20日 10:17:48 作者：清阿哥、

這篇文章主要介紹了使用el-form之表單校驗(yàn)自動(dòng)定位到報(bào)錯(cuò)位置問題，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

1. 背景

表單校驗(yàn)大多數(shù)的表單都會(huì)用到，一般情況下只是提示當(dāng)前哪些項(xiàng)校驗(yàn)不通過，但是如果表單比較需要用戶自己去找是哪項(xiàng)校驗(yàn)不通過，這樣的用戶體驗(yàn)不太好，如果能自動(dòng)定位到當(dāng)前校驗(yàn)不通過的表單項(xiàng)體驗(yàn)會(huì)更好一些（這里是以elementui 的 el-from 組件為例子）

2. 實(shí)現(xiàn)思路

目前有兩個(gè)實(shí)現(xiàn)方法：

方法一

表單校驗(yàn)不通過的時(shí)候，會(huì)在未校驗(yàn)成功的表單 el-form-item 標(biāo)簽上加一個(gè)類名 is-error，可以從這個(gè)類名下手，獲取當(dāng)前校驗(yàn)不通過的所有的類名，然后通過 scrollIntoView 方法進(jìn)行自動(dòng)滑動(dòng)到當(dāng)前報(bào)錯(cuò)的表單項(xiàng)位置

方法二

利用el-form提供的 validate 方法的第二個(gè)參數(shù)，獲取當(dāng)前校驗(yàn)不通過的rule 對象，獲取到報(bào)錯(cuò)的 prop 后，在每個(gè)需要加表單校驗(yàn)的項(xiàng)上加上 ref，ref 的綁定值和 prop 保持一致這樣方便直接定位到哪個(gè)prop，然后和第一個(gè)方法一樣利用 scrollIntoView 方法結(jié)合$ref 獲取到 $el 實(shí)現(xiàn)自動(dòng)定位到校驗(yàn)不通過的表單項(xiàng)

3. 實(shí)現(xiàn)代碼

方法一

實(shí)現(xiàn)代碼：

 	// 表單校驗(yàn)
    verifyForm() {
      this.$refs.basicInfoRule.validate(valid => {
        if (valid) {
          // 校驗(yàn)通過執(zhí)行的邏輯
        } else {
          // 校驗(yàn)不通過自動(dòng)定位到不通過的表單項(xiàng)
          this.moveToErr()
        }
      })
    },
    // 自動(dòng)定位到表單報(bào)錯(cuò)項(xiàng)
    moveToErr() {
      this.$nextTick(() => {
        let isError = document.getElementsByClassName('is-error')
        if (isError.length) {
          isError[0].scrollIntoView({
            block: 'center',
            behavior: 'smooth'
          })
	// 這個(gè)當(dāng)滑動(dòng)到報(bào)錯(cuò)項(xiàng)之后自動(dòng)獲取輸入框的焦點(diǎn)，方便用戶直接進(jìn)行輸入，延遲 800ms 是因?yàn)樾枰寄艿蕉ㄎ怀晒笤谶M(jìn)行獲取焦點(diǎn)體驗(yàn)更好一些
          setTimeout(() => {
            if (isError[0].previousElementSibling.querySelector('input')) {
              isError[0].previousElementSibling.querySelector('input').focus()
            }
          }, 800)
        }
      })
    }

方法二

實(shí)現(xiàn)代碼：

模板示例代碼

   <el-form-item label="姓名：" prop="name" ref="name">
        <el-input
          v-model.number="form."
          placeholder="請輸入姓名"
          clearable
        ></el-input>
      </el-form-item>

 verifyForm() {
      this.$refs.ruleForm.validate((valid, object) => {
        if (valid) {
          //校驗(yàn)通過執(zhí)行邏輯
        } else {
          let errorArr = [];
          for (let key in object) {
            object[key].forEach((item) => {
              errorArr.push(item.message);
            });
            let dom = this.$refs[Object.keys(object)[0]];
            if (Object.prototype.toString.call(dom) !== '[object Object]') {
              dom = dom[0];
              break; //結(jié)束語句并跳出語句，進(jìn)行下個(gè)語句執(zhí)行
            }
            // 定位到報(bào)錯(cuò)項(xiàng)
            dom.$el.scrollIntoView({
              block: 'center',
              behavior: 'smooth',
            });
          }
          // 頁面提示未通過校驗(yàn)字段項(xiàng)，
          this.$message.error(errorArr[0]);
        }
      });
    },

4. 拓展（踩坑…）

由于頁面比較復(fù)雜分了好幾個(gè)子組件，而且子組件中都有需要校驗(yàn)的表單項(xiàng)，在父組件保存表單前，需要調(diào)用各個(gè)子組件的表單校驗(yàn)方法，發(fā)現(xiàn)el-form 的 validate 方法不能返會(huì)校驗(yàn)失敗還是校驗(yàn)成功

錯(cuò)誤代碼示范：

// 子組件代碼
   verifyForm() {
      this.$refs.basicInfoRule.validate(valid => {
        if (valid) {
          // 校驗(yàn)通過
          return true
        } else {
          // 校驗(yàn)不通過
          return false
        }
      })
    },
    // 父組件代碼
    // 校驗(yàn)子組件表單（通過子組件綁定的ref來調(diào)用子組件的校驗(yàn)方法）
    async handleVerify() {
      if (
        !(await this.$refs.basicInfo?.verifyForm()) ||
        !(await this.$refs.priceSetting?.verifyForm())
      ) {
        this.$message.warning('請完善表單必填項(xiàng)')
        return false
      }
      return true
    },
    // 保存
      async saveMainDetail() {
      try {
        if (!(await this.handleVerify())) return
        } catch (e) {}

上述代碼在父組件里面不能獲取到組件的校驗(yàn)狀態(tài)，子組件換一個(gè)寫法就行了

正確代碼示范：

使用 Promise 來返回表單的是否校驗(yàn)成功狀態(tài)能在父組件成功拿到了

// 子組件代碼
 verifyForm() {
      return new Promise((resolve, reject) => {
        this.$refs.basicInfoRule.validate(valid => {
          if (valid) {
            console.log(valid, '校驗(yàn)通過')
            resolve(true)
          } else {
            console.log(valid, '校驗(yàn)不通過')
            reject(new Error())
          }
        })
      })
    }

心得：

實(shí)現(xiàn)功能的思路有很多，這里我列舉出來的兩種，看實(shí)際的功能和需求找到適合自己的方法~

el-form校驗(yàn)失敗時(shí)定位到失敗項(xiàng)

需求

提交的表單過長，出現(xiàn)滾動(dòng)條時(shí)，點(diǎn)擊‘確定’觸發(fā)表單檢驗(yàn)后，頁面看不到的表單項(xiàng)報(bào)錯(cuò)，但是用戶在頁面不能感知到，這時(shí)需要將滾動(dòng)條滾動(dòng)至校驗(yàn)失敗項(xiàng)處。

如圖：控制臺(tái)提示校驗(yàn)失敗，頁面顯示正常，用戶無感知。

思路

表單校驗(yàn)失敗時(shí)，失敗項(xiàng)有is-error類，獲取這個(gè)元素，使用scrollIntoView()方法。

scollIntoView()將調(diào)用它的元素滾動(dòng)到瀏覽器窗口的可見區(qū)域。

js代碼

moveToErr () {
  this.$nextTick(() => {
    let isError = document.getElementsByClassName('is-error')
    if (isError.length) {
      isError[0].scrollIntoView({
        block: 'center',
        behavior: 'smooth'
      })
    }
  })
}