Vue模仿ElementUI的form表單實例代碼
實現(xiàn)要求
模仿 ElementUI 的表單,分為四層結(jié)構(gòu):index 組件、Form 表單組件、FormItem 表單項組件、Input 和 CheckBox 組件,具體分工如下:
index 組件:
- 實現(xiàn):分別引入 Form 組件、FormItem 組件、Input 組件,實現(xiàn)組裝;
Form 表單組件:
- 實現(xiàn):預留插槽、管理數(shù)據(jù)模型 model、自定義校驗規(guī)則 rules、全局校驗方法 validate;
FormItem 表單項組件:
- 實現(xiàn):預留插槽、顯示 label 標簽、執(zhí)行數(shù)據(jù)校驗、顯示校驗結(jié)果;
Input 和 CheckBox 組件:
- 實現(xiàn):綁定數(shù)據(jù)模型 v-model、通知 FormItem 組件執(zhí)行校驗;
Input 組件
具體實現(xiàn)如下:
1、自定義組件要實現(xiàn) v-model 必須實現(xiàn) :value 和 @input。
2、當輸入框中的數(shù)據(jù)發(fā)生變化時,通知父組件執(zhí)行校驗。
3、當 Input 組件綁定的 type 類型為 password 時,在組件內(nèi)部使用 v-bind="$attrs" 獲取 props 之外的內(nèi)容。
4、設置 inheritAttrs 為 false, 從而避免頂層容器繼承屬性。
Input 組件實現(xiàn):
<template> <div> <input :value="value" @input="onInput" v-bind="$attrs" /> </div> </template> <script> export default { inheritAttrs: false, // 避免頂層容器繼承屬性 props: { value: { type: String, default: "" } }, data() { return {}; }, methods: { onInput(e) { // 通知父組件數(shù)值發(fā)生變化 this.$emit("input", e.target.value); // 通知 FormItem 執(zhí)行校驗 // 這種寫法不健壯,因為 Input 組件和 FormItem 組件之間可能會隔代 this.$parent.$emit("validate"); } } }; </script> <style scoped></style>
注意:代碼中使用 this.$parent 派發(fā)事件,這種寫法不健壯,當 Input 組件和 FormItem 組件之間隔代時會出現(xiàn)問題。具體解決方式見文章尾部代碼優(yōu)化部分。
CheckBox 組件
1、自定義實現(xiàn) checkBox 的雙向數(shù)據(jù)綁定,和 input 大同小異,必須實現(xiàn) :checked 和 @change。
CheckBox 組件實現(xiàn):
<template> <section> <input type="checkbox" :checked="checked" @change="onChange" /> </section> </template> <script> export default { props: { checked: { type: Boolean, default: false } }, model: { prop: "checked", event: "change" }, methods: { onChange(e) { this.$emit("change", e.target.checked); this.$parent.$emit("validate"); } } }; </script> <style scoped lang="less"></style>
FormItem 組件
具體實現(xiàn)如下:
1、給 Input 組件或者 CheckBox 組件預留插槽。
2、如果用戶在組件上設置 label 屬性,要展示 label 標簽。
3、監(jiān)聽校驗事件,并執(zhí)行校驗(使用 async-validator 插件進行校驗)。
4、如果不符合校驗規(guī)則,需要顯示校驗結(jié)果。
在開發(fā)的過程中,我們需要思考幾個問題:
1、在組件內(nèi)部,如何得到需要校驗的數(shù)據(jù)和校驗規(guī)則?
2、在 Form 表單中會有多個菜單項,如:用戶名、密碼、郵箱...等等,那么 FormItem 組件是如何得知現(xiàn)在校驗的是哪個菜單呢?
FormItem 組件實現(xiàn):
<template> <div class="formItem-wrapper"> <div class="content"> <label v-if="label" :style="{ width: labelWidth }">{{ label }}:</label> <slot></slot> </div> <p v-if="errorMessage" class="errorStyle">{{ errorMessage }}</p> </div> </template> <script> import Schema from "async-validator"; export default { inject: ["formModel"], props: { label: { type: String, default: "" }, prop: String }, data() { return { errorMessage: "", labelWidth: this.formModel.labelWidth }; }, mounted() { // 監(jiān)聽校驗事件,并執(zhí)行校驗 this.$on("validate", () => { this.validate(); }); }, methods: { validate() { // 執(zhí)行組件的校驗 // 1、獲取數(shù)據(jù) const values = this.formModel.model[this.prop]; // 2、獲取校驗規(guī)則 const rules = this.formModel.rules[this.prop]; // 3、執(zhí)行校驗 const schema = new Schema({ [this.prop]: rules }); // 參數(shù)1是值,餐數(shù)2是校驗錯誤對象數(shù)組 // validate 返回的是 Promise<Boolean> return schema.validate({ [this.prop]: values }, errors => { if (errors) { this.errorMessage = errors[0].message; } else { this.errorMessage = ""; } }); } } }; </script> <style scoped lang="less"> @labelWidth: 90px; .formItem-wrapper { padding-bottom: 10px; } .content { display: flex; } .errorStyle { font-size: 12px; color: red; margin: 0; padding-left: @labelWidth; } </style>
我們先回答一下上面提出的兩個問題,此處會涉及到組件之間傳值,可以參考之前的文章《組件傳值、通訊》:
首先表單的數(shù)據(jù)和校驗規(guī)則是定義在 index 組件內(nèi)部,并且掛載在 Form 組件上,表單的校驗項發(fā)生在 FormItem 組件中,先在 Form 組件內(nèi)部通過 props 接受到傳遞的數(shù)據(jù),然后通過 provide/inject 的方式在 FormItem 組件中傳遞給后代組件。
我們?nèi)粘T谟?ElementUI 的表單校驗是會發(fā)現(xiàn),在每一個需要校驗的表單上會設置一個 prop 屬性,并且屬性值和綁定的數(shù)據(jù)一致。此處的用途是為了能夠在 FormItem 組件中執(zhí)行校驗時獲取相對的校驗規(guī)則和數(shù)據(jù)對象。
在 FormItem 組件中通過使用 inject 獲取注入的 Form 實例,和 prop 屬性組合使用,可以獲取到表單數(shù)據(jù)和校驗規(guī)則。
// 1、獲取數(shù)據(jù) const values = this.formModel.model[this.prop]; // 2、獲取校驗規(guī)則 const rules = this.formModel.rules[this.prop];
使用 async-validator 插件實例化一個 schema 對象,用來執(zhí)行校驗,schema.validate 需要傳遞兩個參數(shù),參數(shù)1是當前需要校驗的字段和相對應的 rules 組成的鍵值對對象,參數(shù)2是一個 callback 函數(shù),用來獲取錯誤信息(是一個數(shù)組)。validate 方法返回的是一個 Promise<Boolean>。
注意:此組件的 validate 方法中,最后使用 return 的目的是為了在 Form 組件中執(zhí)行全局校驗使用。
Form 組件
具體實現(xiàn)如下:
1、給 FormItem 組件預留插槽。
2、傳遞 Form 實例給后代,比如 FormItem 用來獲取校驗的數(shù)據(jù)和規(guī)則。
3、執(zhí)行全局校驗
Form 組件實現(xiàn):
<template> <div> <slot></slot> </div> </template> <script> export default { provide() { return { formModel: this // 傳遞 Form 實例給后代,比如 FormItem 用來獲取校驗的數(shù)據(jù)和規(guī)則 }; }, props: { model: { type: Object, required: true }, rules: { type: Object }, labelWidth: String }, data() { return {}; }, methods: { validate(cb) { // 執(zhí)行全局校驗 // map 結(jié)果是若干 Promise 數(shù)組 const tasks = this.$children.filter(item => item.prop).map(item => item.validate()); // 所有任務必須全部校驗成功才算校驗通過 Promise.all(tasks) .then(() => { cb(true); }) .catch(() => { cb(false); }); } } }; </script> <style scoped></style>
我們在 Form 組件中使用 provide 注入當前組件對象,方便后續(xù)子孫代獲取數(shù)據(jù)/方法使用。
執(zhí)行全局校驗的時候,先使用 filter 過濾掉不需要校驗的組件(我們在 FormItem 組件上設置的 prop 屬性,只要有此屬性,就是需要校驗的),然后分別執(zhí)行組件中的 validate 方法(如果在 FormItem 組件中不使用 return 數(shù)據(jù),最后獲取到的全都是 undefined),返回的是一個若干 Promise 數(shù)組。
簡單介紹一個 Promise.all() 方法:
Promise.all() 方法接收一個promise的iterable類型(注:Array,Map,Set都屬于ES6的iterable類型)的輸入,并且只返回一個Promise實例, 那個輸入的所有promise的resolve回調(diào)的結(jié)果是一個數(shù)組。這個Promise的resolve回調(diào)執(zhí)行是在所有輸入的promise的resolve回調(diào)都結(jié)束,或者輸入的iterable里沒有promise了的時候。它的reject回調(diào)執(zhí)行是,只要任何一個輸入的promise的reject回調(diào)執(zhí)行或者輸入不合法的promise就會立即拋出錯誤,并且reject的是第一個拋出的錯誤信息。
index 組件
定義模型數(shù)據(jù)、校驗規(guī)則等等,分別引入 Form 組件、FormItem 組件、Input 組件,實現(xiàn)組裝。
index 組件實現(xiàn):
<template> <div> <Form :model="formModel" :rules="rules" ref="loginForm" label-width="90px"> <FormItem label="用戶名" prop="username"> <Input v-model="formModel.username"></Input> </FormItem> <FormItem label="密碼" prop="password"> <Input type="password" v-model="formModel.password"></Input> </FormItem> <FormItem label="記住密碼" prop="remember"> <CheckBox v-model="formModel.remember"></CheckBox> </FormItem> <FormItem> <button @click="onLogin">登錄</button> </FormItem> </Form> </div> </template> <script> import Input from "@/components/form/Input"; import CheckBox from '@/components/form/CheckBox' import FormItem from "@/components/form/FormItem"; import Form from "@/components/form/Form"; export default { data() { const validateName = (rule, value, callback) => { if (!value) { callback(new Error("用戶名不能為空")); } else if (value !== "admin") { callback(new Error("用戶名錯誤 - admin")); } else { callback(); } }; const validatePass = (rule, value, callback) => { if (!value) { callback(false); } else { callback(); } }; return { formModel: { username: "", password: "", remember: false }, rules: { username: [{ required: true, validator: validateName }], password: [{ required: true, message: "密碼必填" }], remember: [{ required: true, message: "記住密碼必選", validator: validatePass }] } }; }, methods: { onLogin() { this.$refs.loginForm.validate(isValid => { if (isValid) { alert("登錄成功"); } else { alert("登錄失敗"); } }); } }, components: { Input, CheckBox, FormItem, Form } }; </script> <style scoped></style>
當我們點擊登錄按鈕時,會執(zhí)行全局校驗方法,我們可以使用 this.$refs.xxx 獲取 DOM 元素和組件實例。
在上面我們還留了一個小尾巴~,就是在 Input 組件中通知父組件執(zhí)行校驗,目前使用的是 this.$parent.$emit(),這樣寫有一個弊端,就是當 Input 組件和 FormItem 組件之后隔代的時候,再使用 this.$parent 獲取不到 FormItem 組件。
我們可以封裝一個 dispatch 方法,主要實現(xiàn)向上循環(huán)查找父元素并且派發(fā)事件,代碼實現(xiàn)如下:
dispatch(eventName, data) { let parent = this.$parent; // 查找父元素 while (parent) { // 父元素用$emit觸發(fā) parent.$emit(eventName, data); // 遞歸查找父元素 parent = parent.$parent; } }
該方法可以借用 mixins 引入使用:mixins/emmiters.js
export default { methods: { dispatch(eventName, data) { let parent = this.$parent; // 查找父元素 while (parent) { // 父元素用$emit觸發(fā) parent.$emit(eventName, data); // 遞歸查找父元素 parent = parent.$parent; } } } };
修改 Input 組件:
<template> <div> <input :value="value" @input="onInput" v-bind="$attrs" /> </div> </template> <script> import emmiter from "@/mixins/emmiter"; export default { inheritAttrs: false, // 避免頂層容器繼承屬性 mixins: [emmiter], props: { value: { type: String, default: "" } }, data() { return {}; }, methods: { onInput(e) { // 通知父組件數(shù)值發(fā)生變化 this.$emit("input", e.target.value); // 通知 FormItem 執(zhí)行校驗 // 這種寫法不健壯,因為 Input 組件和 FormItem 組件之間可能會隔代 // this.$parent.$emit("validate"); this.dispatch("validate"); // 使用 mixin 中 emmiter 的 dispatch,解決跨級問題 } } }; </script> <style scoped></style>
總結(jié)
到此這篇關于Vue模仿ElementUI的form表單的文章就介紹到這了,更多相關Vue模仿ElementUI form表單內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
如何使用el-cascader組件寫下拉級聯(lián)多選及全選功能
這篇文章主要介紹了如何使用el-cascader組件寫下拉級聯(lián)多選及全選功能,因為是有全選的功能,所以不能直接使用el-cascader組件,?而是選擇使用el-select組件,?在此組件內(nèi)部使用el-cascader-panel級聯(lián)面板,感興趣的朋友跟隨小編一起看看吧2024-03-03Vue循環(huán)遍歷選項賦值到對應控件的實現(xiàn)方法
這篇文章主要介紹了Vue-循環(huán)遍歷選項賦值到對應控件的實現(xiàn)方法啊,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-06-06關于ELement?UI時間控件el-date-picker誤差8小時的問題
本文探討了在使用Vue前端框架配合ElementUI開發(fā)時,遇到日期時間選擇器DateTimePicker的時間同步問題,通過揭示中國東八區(qū)與格林威治時間的時差,作者提供了設置value-format屬性的解決方案,以確保后端接收到的正確時間格式2024-08-08vue實現(xiàn)樹形結(jié)構(gòu)增刪改查的示例代碼
其實很多公司都會有類似于用戶權(quán)限樹的增刪改查功能,本文主要介紹了vue實現(xiàn)樹形結(jié)構(gòu)增刪改查,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-09-09vue3動態(tài)路由刷新出現(xiàn)空白頁的原因與最優(yōu)解
頁面刷新白屏其實是因為vuex引起的,由于刷新頁面vuex數(shù)據(jù)會丟失,這篇文章主要給大家介紹了關于vue3動態(tài)路由刷新出現(xiàn)空白頁的原因與最優(yōu)解的相關資料,需要的朋友可以參考下2023-11-11