基于 el-form 封裝一個依賴 json 動態渲染的表單控件

封裝表單子控件

表單控件需要很多子控件,所以要先封裝一下子控件,然后才方便封裝表單控件。

定義接口,統一規范

表單子控件有一個相同的需求,都需要實現屬性和 v-model 數據交換,因為 element 把 value 給封裝成了v-model,所以無法直接綁定組件的屬性,必須建立一個內部變量來綁定。

所以需要一個轉換的方式,這里采用自定義ref來實現,順便實現了一下防抖功能。

雖然在表單控件里面并不需要防抖功能,但是查詢的時候需要,而表單子控件是可以通用到查詢控件里面的。

定義一個 v-model 和 my-change

// 自定義 ref

/**

* 自定義的ref,實現屬性和內部變量的數據轉換

* @param { reactive } props 組件的屬性

* @param { object } context 組件的上下文

* @param { number } delay 延遲刷新的時間,單位:毫秒,默認:0

* @param { string } name 要對應的屬性名稱,默認:modelValue

* @returns 自定義的ref

*/

export const debounceRef = (props, context, delay = 0, name = 'modelValue') => {

? let _value = props[name]

? // 計時器

? let timeout

? // 是否輸入狀態。輸入時取 value;輸入完畢取 modelValue 屬性

? let isInput = false

? return customRef((track, trigger) => {

? ? return {

? ? ? get () {

? ? ? ? track()

? ? ? ? if (isInput) {

? ? ? ? ? // console.log(isInput)

? ? ? ? ? return _value

? ? ? ? } else {

? ? ? ? ? // console.log(isInput)

? ? ? ? ? return props[name]

? ? ? ? }

? ? ? },

? ? ? set (newValue) {

? ? ? ? isInput = true

? ? ? ? _value = newValue // 綁定值

? ? ? ? trigger() // 組件內部刷新模板

? ? ? ? clearTimeout(timeout) // 清掉上一次的計時

? ? ? ? timeout = setTimeout(() => {

? ? ? ? ? // 修改 modelValue 屬性

? ? ? ? ? context.emit(`update:${name}`, newValue) // 提交給父組件

? ? ? ? ? // 用于區分是哪個組件觸發的事件。

? ? ? ? ? context.emit('my-change', newValue, props.controlId, props.colName)

? ? ? ? ? isInput = false

? ? ? ? }, delay)

? ? ? }

? ? }

? })

}

封裝各種表單子控件

按照原子性原則,子控件封裝的比較細,直接看圖:

表單子控件

代碼有點多,不一一介紹了,感興趣的可以看源碼。

封裝表單控件

基礎工作做好之后,我們就可以封裝 el-form 了。

定義屬性

依據 el-form 的屬性我們定義幾個關鍵性屬性

介紹屬性

/**

* 表單控件需要的屬性

*/

export const formProps = {

? modelValue: Object, // 完整的model

? partModel: Object, // 根據選項過濾后的model

? miniModel: Object, // 精簡的model

? /*

? * 自定義子控件 key:value形式

? * * key: 編號。1:插槽;100-200:保留編號

? * * value:string:標簽;函數:異步組件,類似路由的設置

? */

? customerControl: { // 自定義的表單子組件

? ? type: Object,

? ? defaule: () => {}

? },

? colOrder: { // 表單字段的排序的依據

? ? type: Array,

? ? default: () => []

? },

? formColCount: { // 表單的列數

? ? type: Number,

? ? default: 1

? },

? reload: {

? ? type: Boolean, // 是否重新加載配置,需要來回取反

? ? default: false

? },

? itemMeta: {

? ? type: Object, // 表單子控件的屬性

? ? default: () => {}

? },

? ruleMeta: { // 驗證信息

? ? type: Object,

? ? default: () => {}

? },

? formColShow: { // 數據變化,聯動組件是否顯示

? ? type: Object,

? ? default: () => {}

? }

}

定義內部model

一般一個 model 就可以,只是這里做了一個組件聯動的,那么如果只需要獲取可見的組件的值呢,于是做了局部model。

model

實現多行多列和布局調整

采用 el-col 實現,通過控制 span 來實現多列,所以理論上最多支持24列,當然這個要看屏幕寬度了。

/**

* 處理一個字段占用幾個td的需求

* @param { object } props 表單組件的屬性

* @returns

*/

const getColSpan = (props) => {

? // 確定一個組件占用幾個格子

? const formColSpan = reactive({})


? // 表單子控件的屬性

? const formItemProps = props.itemMeta

? // 根據配置里面的colCount,設置 formColSpan

? const setFormColSpan = () => {

? ? const formColCount = props.formColCount // 列數

? ? const moreColSpan = 24 / formColCount // 一個格子占多少份

? ? if (formColCount === 1) {

? ? // 一列的情況

? ? ? for (const key in formItemProps) {

? ? ? ? const m = formItemProps[key]

? ? ? ? if (typeof m.colCount === 'undefined') {

? ? ? ? ? formColSpan[m.controlId] = moreColSpan

? ? ? ? } else {

? ? ? ? ? if (m.colCount >= 1) {

? ? ? ? ? ? // 單列,多占的也只有24格

? ? ? ? ? ? formColSpan[m.controlId] = moreColSpan

? ? ? ? ? } else if (m.colCount < 0) {

? ? ? ? ? ? // 擠一擠的情況, 24 除以 占的份數

? ? ? ? ? ? formColSpan[m.controlId] = moreColSpan / (0 - m.colCount)

? ? ? ? ? }

? ? ? ? }

? ? ? }

? ? } else {

? ? ? // 多列的情況

? ? ? for (const key in formItemProps) {

? ? ? ? const m = formItemProps[key]

? ? ? ? if (typeof m.colCount === 'undefined') {

? ? ? ? ? formColSpan[m.controlId] = moreColSpan

? ? ? ? } else {

? ? ? ? ? if (m.colCount < 0 || m.colCount === 1) {

? ? ? ? ? ? // 多列,擠一擠的占一份

? ? ? ? ? ? formColSpan[m.controlId] = moreColSpan

? ? ? ? ? } else if (m.colCount > 1) {

? ? ? ? ? ? // 多列,占的格子數 * 份數

? ? ? ? ? ? formColSpan[m.controlId] = moreColSpan * m.colCount

? ? ? ? ? }

? ? ? ? }

? ? ? }

? ? }

? }

? return {

? ? formColSpan,

? ? setFormColSpan

? }

}

首先計算一下一列要用多少個span,也就是用24除以列數。

然后判斷是不是單列,單列要處理多個組件占用一個位置的需求,多列要處理一個組件占用多個位置的需求。

實現擴展

表單子控件可以多種多樣,無法完全封裝進入表單控件,那么就需要表單控件支持子控件的擴展。

這里要感謝 vue 的動態組件功能,讓擴展子控件變得非常方便。

我們使用 component 和動態組件來實現表單子控件的加載。

<component

? ? :is="formItemListKey[getCtrMeta(ctrId).controlType]"

? ? v-model="formModel[getCtrMeta(ctrId).colName]"

? ? v-bind="getCtrMeta(ctrId)"

? ? @my-change="myChange">

? </component>

export const formItemList = {

? // 文本類 defineComponent

? 'el-form-text': defineAsyncComponent(() => import('./t-text.vue')),

? 'el-form-area': defineAsyncComponent(() => import('./t-area.vue')),

? 'el-form-url': defineAsyncComponent(() => import('./t-url.vue')),

? 'el-form-password': defineAsyncComponent(() => import('./t-password.vue')),

? // 數字

? 'el-form-number': defineAsyncComponent(() => import('./n-number.vue')),

? 'el-form-range': defineAsyncComponent(() => import('./n-range.vue')),

? // 日期、時間

? 'el-form-date': defineAsyncComponent(() => import('./d-date.vue')),

? 'el-form-datetime': defineAsyncComponent(() => import('./d-datetime.vue')),

? 'el-form-year': defineAsyncComponent(() => import('./d-year.vue')),

? 'el-form-month': defineAsyncComponent(() => import('./d-month.vue')),

? 'el-form-week': defineAsyncComponent(() => import('./d-week.vue')),

? 'el-form-time-select': defineAsyncComponent(() => import('./d-time-select.vue')),

? 'el-form-time-picker': defineAsyncComponent(() => import('./d-time-picker.vue')),

? // 選擇、開關

? 'el-form-checkbox': defineAsyncComponent(() => import('./s-checkbox.vue')),

? 'el-form-switch': defineAsyncComponent(() => import('./s-switch.vue')),

? 'el-form-checkboxs': defineAsyncComponent(() => import('./s-checkboxs.vue')),

? 'el-form-radios': defineAsyncComponent(() => import('./s-radios.vue')),

? 'el-form-select': defineAsyncComponent(() => import('./s-select.vue')),

? 'el-form-selwrite': defineAsyncComponent(() => import('./s-selwrite.vue')),

? 'el-form-select-cascader': defineAsyncComponent(() => import('./s-select-cascader.vue'))

}

/**

* 動態組件的字典,便于v-for循環里面設置控件

*/

export const formItemListKey = {

? // 文本類

? 100: formItemList['el-form-area'], // 多行文本

? 101: formItemList['el-form-text'], // 單行文本

? 102: formItemList['el-form-password'], // 密碼

? 103: formItemList['el-form-text'], // 電話

? 104: formItemList['el-form-text'], // 郵件

? 105: formItemList['el-form-url'], // url

? 106: formItemList['el-form-text'], // 搜索

? // 數字

? 120: formItemList['el-form-number'], // 數字

? 121: formItemList['el-form-range'], // 滑塊

? // 日期、時間

? 110: formItemList['el-form-date'], // 日期

? 111: formItemList['el-form-datetime'], // 日期 + 時間

? 112: formItemList['el-form-month'], // 年月

? 113: formItemList['el-form-week'], // 年周

? 114: formItemList['el-form-year'], // 年

? 115: formItemList['el-form-time-picker'], // 任意時間

? 116: formItemList['el-form-time-select'], // 選擇固定時間

? // 選擇、開關

? 150: formItemList['el-form-checkbox'], // 勾選

? 151: formItemList['el-form-switch'], // 開關

? 152: formItemList['el-form-checkboxs'], // 多選組

? 153: formItemList['el-form-radios'], // 單選組

? 160: formItemList['el-form-select'], // 下拉

? 161: formItemList['el-form-selwrite'], // 下拉多選

? 162: formItemList['el-form-select-cascader'] // 下拉聯動

}

需要擴展子控件的時候,我們只需要向字典(dict)里面添加需要的組件即可,然后設置一個新的編號。

? // 添加臨時動態組件

? formProps.customerControl = {

? ? 300: 'el-transfer'

? }

? // 設置表單字段

? childMeta.select.controlType = 300

為啥用編號?雖然編號不易讀,但是編號穩定,而且靈活。如果我們要基于ant design Vue 封裝控件的話,我可以直接用編號,但是如果用名稱的話,那么要不要區分 el- 和 a- 呢?

實現數據聯動

聯動分為數據聯動,和組件聯動,數據聯動可以依賴UI庫的組件來實現,或者依賴Vue的數據的響應性來實現。

比如常見的省市區縣聯動,我們可以用 el-cascader。

如果需要使用多個組件的話,我們可以監聽組件的值的變化,然后獲取數據綁定下一個組件的options。

// 數據聯動

? watch (() => model.provinces, (v1, v2) => {

? ? console.log('監聽值的變化', v1)

? ? const arr = [

? ? ? {"value": 1 + v1, "label": "多選 選項一" + v1},

? ? ? {"value": 2 + v1, "label": "多選 選項二" + v1}

? ? ]


? ? childMeta.city.optionList.length = 0

? ? childMeta.city.optionList.push(...arr)

? })

Vue 就是數據驅動的,所以聯動的話也是直接監聽value的改變即可,不用像以前那樣要設置change事件了。

實現組件聯動

組件聯動,就是一個組件的值發生變化,影響其他組件的顯示狀態。

企業用戶

個人用戶

比如在注冊的時候,需要選擇企業用戶還是個人用戶。

如果是企業用戶,需要添加企業名稱(以及相關信息);

如果是個人注冊那么只需要填寫個人姓名即可。

這樣表單里面顯示的組件就要隨之變化。

對于這類的需求,我們可以配置一下 formColShow 屬性。

? ? "formColShow": {

? ? ? "90": {? // 組件ID

? ? ? ? "1": [90, 101, 100, 102, 105],? // 組件值對應的需要顯示的組件ID,下同

? ? ? ? "2": [90, 120, 121],

? ? ? ? "3": [90, 110, 114, 112, 113, 115, 116],

? ? ? ? "4": [90, 150, 151, 152, 153, 160, 162]

? ? ? }

? ? },

配置好之后就可以實現了,表單控件內部代碼會做一個 watch 監聽:

? // 數據變化,聯動組件的顯示

? if (typeof props.formColShow !== 'undefined') {

? ? for (const key in props.formColShow) {

? ? ? const ctl = props.formColShow[key]

? ? ? const colName = props.itemMeta[key].colName

? ? ? // 監聽組件的值,有變化就重新設置局部model

? ? ? watch(() => formModel[colName], (v1, v2) => {

? ? ? ? if (typeof ctl[v1] === 'undefined') {

? ? ? ? ? // 沒有設定,顯示默認組件

? ? ? ? ? setFormColSort()

? ? ? ? } else {

? ? ? ? ? // 按照設定顯示組件

? ? ? ? ? setFormColSort(ctl[v1])

? ? ? ? ? // 設置部分的 model

? ? ? ? ? createPartModel(ctl[v1])

? ? ? ? }

? ? ? })

? ? }

json格式

整個表單是依據 json 動態渲染出來的,那么json格式是啥樣的呢?分為兩個部分,一個是表單控件自己需要的屬性,另一個是表單子控件需要的屬性,還有驗證規則等。

{

? "formTest": {

? ? "baseProps": { // 表單控件自己的屬性

? ? ? "formColCount": 1, // 列數

? ? ? "colOrder": [ // 需要顯示的組件的ID

? ? ? ? 90,? 101, 102,

? ? ? ? 110, 111, 114, 112, 113, 115, 116,

? ? ? ? 120, 121, 100,

? ? ? ? 150, 151, 152, 153,

? ? ? ? 160, 162

? ? ? ]

? ? },

? ? "formColShow": { // 組件聯動的信息

? ? ? "90": { // 觸發的組件

? ? ? ? "1": [90, 101, 100, 102, 105], // 組件值對應的需要顯示的組件的ID

? ? ? ? "2": [90, 120, 121],

? ? ? ? "3": [90, 110, 114, 112, 113, 115, 116],

? ? ? ? "4": [90, 150, 151, 153, 152, 160, 162]

? ? ? }

? ? },

? ? "ruleMeta": { // 驗證規則

? ? ? "101": [ // 表單子控件的ID,下面是驗證規則

? ? ? ? { "trigger": "blur", "message": "請輸入活動名稱", "required": true },

? ? ? ? { "trigger": "blur", "message": "長度在 3 到 5 個字符", "min": 3, "max": 5 }

? ? ? ]

? ? },

? ? "itemMeta": { // 表單子控件的屬性

? ? ? "90": {?

? ? ? ? "controlId": 90,

? ? ? ? "colName": "kind",

? ? ? ? "label": "分類",

? ? ? ? "controlType": 153,

? ? ? ? "isClear": false,

? ? ? ? "defaultValue": "",

? ? ? ? "placeholder": "分類",

? ? ? ? "title": "編號",

? ? ? ? "optionList": [

? ? ? ? ? {"value": 1, "label": "文本類"},

? ? ? ? ? {"value": 2, "label": "數字類"},

? ? ? ? ? {"value": 3, "label": "日期類"},

? ? ? ? ? {"value": 4, "label": "選擇類"}

? ? ? ? ],

? ? ? ? "colCount": 1

? ? ? },

? ? ? "100": {?

? ? ? ? "controlId": 100,

? ? ? ? "colName": "area",

? ? ? ? "label": "多行文本",

? ? ? ? "controlType": 100,

? ? ? ? "isClear": false,

? ? ? ? "defaultValue": 1000,

? ? ? ? "placeholder": "多行文本",

? ? ? ? "title": "多行文本",

? ? ? ? "colCount": 1

? ? ? },

? ? ? ...

? ? }

? }

}

遍歷子控件

因為子控件都封裝好了,所以只需要簡單遍歷即可:

? <el-form

? ? :model="formModel"

? ? :rules="rules"

? ? ref="formControl"

? ? :inline="false"

? ? class="demo-form-inline"

? ? label-suffix=":"

? ? label-width="130px"

? ? size="mini"

? >

? ? <el-row>

? ? ? <!--不循環row,直接循環col,放不下會自動往下換行。-->

? ? ? <el-col

? ? ? ? v-for="(ctrId, index) in formColSort"

? ? ? ? :key="'form_'+index"

? ? ? ? :span="formColSpan[ctrId]"

? ? ? ><!--:prop="getCtrMeta(ctrId).colName"-->

? ? ? ? <el-form-item

? ? ? ? ? :label="getCtrMeta(ctrId).label"

? ? ? ? ? :prop="getCtrMeta(ctrId).colName"

? ? ? ? >

? ? ? ? ? <!--判斷要不要加載插槽-->

? ? ? ? ? <template v-if="getCtrMeta(ctrId).controlType === 1">

? ? ? ? ? ? <!--<slot :name="ctrId">父組件沒有設置插槽</slot>-->

? ? ? ? ? ? <slot :name="getCtrMeta(ctrId).colName">父組件沒有設置插槽</slot>

? ? ? ? ? </template>

? ? ? ? ? <!--表單item組件,采用動態組件的方式-->

? ? ? ? ? <template v-else>

? ? ? ? ? ? <component

? ? ? ? ? ? ? :is="dictControl[getCtrMeta(ctrId).controlType]"

? ? ? ? ? ? ? v-model="formModel[getCtrMeta(ctrId).colName]"

? ? ? ? ? ? ? v-bind="getCtrMeta(ctrId)"

? ? ? ? ? ? ? @my-change="myChange">

? ? ? ? ? ? </component>

? ? ? ? ? </template>

? ? ? ? </el-form-item>

? ? ? </el-col>

? ? </el-row>

? </el-form>

USB Microphone https://www.soft-voice.com/

Wooden Speakers? https://www.zeshuiplatform.com/

亞馬遜測評 www.yisuping.cn

深圳網站建設www.sz886.com

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370

推薦閱讀更多精彩內容