這篇文章主要介紹了Vue ElementUI實現表單動態渲染、可視化配置的方法,需要的朋友可以參考下
動態渲染就是有一個異步的數據,大概長這樣:
{ "inline": true, "labelPosition": "right", "labelWidth": "", "size": "small", "statusIcon": true, "formItemList": [ { "type": "input", "label": "姓名", "disable": false, "readonly": false, "value": "", "placeholder": "请输入姓名", "rules": [], "key": "name", "subtype": "text" }, { "type": "radio", "label": "性别", "value": "", "button": false, "border": true, "rules": [], "key": "gender", "options": [ { "value": "1", "label": "男", "disabled": false }, { "value": "0", "label": "女", "disabled": false } ] } ] }
然後你需要把這個json渲染成這樣:
最後提交表單的資料長這樣:
{ "name": "Genji", "gender": "1" }
然後我們目標就是封裝這樣一個元件:
<dynamic-form :config="someConfig" v-model="someData" />
實作
#開始之前,你需要知道v-model 的工作原理:
<input v-model="something">
這不過是以下範例的語法糖:
<input :value="something" @input="something = $event.target.value">
了解這些後,我們再來一步一步實作這個元件。
首先,把設定轉送到 el-form :
<template> <el-form class="dynamic-form" :inline="formConfig.inline" :model="value" :label-position="formConfig.labelPosition" :label-width="formConfig.labelWidth" :size='formConfig.size' :status-icon="formConfig.statusIcon"> <slot/> </el-form> </template> <script> export default { props: { formConfig: { type: Object, required: true }, value: { type: Object, required: true } }, } </script>
第二步,設定預設值。
因為在每個 form-item
都會需要一個 v-model ,所以在渲染之前,要確保每個欄位都有值。這裡要注意一點,元件內不要直接修改父元件傳入的 prop ,所以我們在這裡用 {...this.value}
快速拷貝一份,最後別忘了通知父元件。程式碼如下:
export default { props: { formConfig: {...}, value: {...}, }, methods: { setDefaultValue() { const formData = { ...this.value } // 设置默认值 this.formConfig.formItemList.forEach(({ key, value }) => { if (formData[key] === undefined || formData[key] === null) { formData[key] = value } }) this.$emit('input', formData) } }, mounted() { this.setDefaultValue() }, }
第三步,渲染 form-item 。
如何把下面的資料渲染成我們熟悉的 el-form-item ?
{ "type": "input", "label": "姓名", "disable": false, "readonly": false, "value": "", "placeholder": "请输入姓名", "rules": [], "key": "name", "subtype": "text" }
第一種,利用vue 內建的component 元件,寫起來可能像這樣:
<el-form-item> <component :is="`el-${item.type}`" /> </el-form-item>
第二種,使用v-if 逐一判斷:
<el-form-item> <el-input v-if="item.type === 'input'" /> <span v-else>未知控件类型</span> </el-form-item>
考慮到每個表單控制項的處理邏輯千差萬別,樓主採用了第二種方式。
根據這個思路,我們來封裝一個dynamic-form-item
,接收一個item ,渲染一個el-form-item :
<template> <el-form-item :rules="item.Rules" :label="item.label" :prop="item.key"> <el-input v-if="item.type==='input'" v-bind="$attrs" v-on="$listeners" :type="item.subtype" :placeholder="item.placeholder" :disabled="item.disable" :readonly="item.readonly" :autosize="item.autosize"></el-input> <el-select v-else-if="item.type==='select'" v-bind="$attrs" v-on="$listeners" :multiple="item.multiple" :disabled="item.disabled" :multiple-limit="item.multipleLimit"> <el-option v-for="o in item.options" :key="o.value" :label="o.label" :value="o.value" :disabled="o.disabled"> </el-option> </el-select> <!--突然有点想念JSX--> ... <span v-else>未知控件类型</span> </el-form-item> </template> <script> export default { props: { item: { type: Object, required: true } } } </script>
tips: 使用 v-bind="$attrs" v-on="$listeners"
可以方便地轉發父元件的 v-model
指令,詳見vue高階元件。
最後,我們就可以循環輸出一個完整的表單了:
<dynamic-form-item v-for="item in formConfig.formItemList" :key="item.key" v-if="value[item.key]!==undefined" :item="item" :value="value[item.key]" @input="handleInput($event, item.key)" />
這裡不能用v-model="value[item.key]"
,上文說了,元件內不能直接修改props,所以這裡我們還是轉發一下。
methods: { handleInput(val, key) { // 这里element-ui没有上报event,直接就是value了 this.$emit('input', { ...this.value, [key]: val }) }, setDefaultValue() {...} },
完整程式碼位址: src/components/dynamic-form/form.vue
##擴充功能
1.數字顯示單位,限制小數位數
element-ui 沒有做這個功能,不過我覺得還是挺常見的,所以使用el-input 手動封裝了一個input-number :
<!--普通使用--> <input-number v-model="someNumber" :min="1" :max="99" :decimal1="2" append="元"></input-number> <!--在dynamic-form-item中的应用--> <input-number v-else-if="item.type==='number'" v-bind="$attrs" v-on="$listeners" :min="item.min" :max="item.max" :decimal1="item.decimal1" :append="item.append" :prepend="item.prepend" :disabled="item.disabled"></input-number>
src/components/dynamic-form/input-number.vue
#2.非同步驗證
得益於async-validator ,我們可以很方便地自訂驗證規則。在設定中
{ "type": "input", ... "rules":[ { "sql": "SELECT {key} FROM balabala", "message": "xx已被占用", "trigger": "blur" } ] }
dynamic-form-item 元件中, 遍歷item.rules , 將sql驗證轉換為自訂validator 函數:
<template> <el-form-item :rules="Rules" > ... </el-form-item> </template> <script> import request from '@/utils/request' export default { props: { item: {...} }, computed: { Rules() { const rules = this.item.rules if (rules === undefined) return undefined const R = [] rules.forEach(rule => { if (rule.sql) { const validator = (rule2, value, callback) => { // 根据项目自行修改 request('/api/validate', 'POST', { key: rule2.field, value, sql: rule.sql.replace(/{key}/ig, rule2.field) }) .then(res => { callback(!res || undefined) }) .catch(err => { this.$message.error(err.message) callback(false) }) } R.push({ validator, message: rule.message, trigger: 'blur' }) } else { R.push(rule) } }) return R } }, } </script>
{ "type": "cascader", ... "areaShortcut": "provinceAndCityData" }
<template> <el-form-item> ... <el-cascader :options="item.options || require('element-china-area-data')[item.areaShortcut]" ></el-cascader> </el-form-item> </template>
{ "type": "checkbox", ... "optionsUrl": "/api/some/options" }
<template> <el-form-item> ... <el-select> <el-option v-for="o in item.options || ajaxOptions" ></el-option> </el-select> </el-form-item> </template> <script> import request from '@/utils/request' export default { props: { item: {...} }, computed: {...}, data() { return { ajaxOptions: [] } }, created() { const { optionsUrl, key, type } = this.item if (optionsUrl) { // 根据项目自行修改 request(`${optionsUrl}?key=${key}`, 'GET') .then(res => { this.ajaxOptions = res }) .catch(err => { this.$message.error(err.message) }) } } } </script>
用Axios Element實作全域的請求loading的方法#
以上是Vue+ElementUI實作表單動態渲染、視覺化配置的方法的詳細內容。更多資訊請關注PHP中文網其他相關文章!