如何寫一個(gè)雙向綁定的VUE組件

最近在重構(gòu)公司項(xiàng)目代碼,因?yàn)橹斑@一塊不是我寫的,所以也抽空看了一下之前同事的代碼,可能是因?yàn)榇蠹叶际浅鯇W(xué)VUE,現(xiàn)在看來,有些代碼還是略顯稚嫩的,有一個(gè)小組件,雖然很簡(jiǎn)單,但是還是可以拿出來說一下的,因?yàn)樗且粋€(gè)雙向綁定組件.

v-model是什么

教程上說的很清楚,v-model是一個(gè)語法糖,它是由 :value@input構(gòu)成的[1]

為什么我需要v-model

使用v-model不僅僅是因?yàn)樗?jiǎn)單,它的意義一方面是簡(jiǎn)化了書寫,二是簡(jiǎn)化了邏輯,三是更加語義化,四是讓API更加友好,簡(jiǎn)單易懂.
在VUE2.5之后,.sync修飾符又重新回歸了,我們可以通過.sync修飾符來處理雙向綁定問題,但是我覺得兩者的使用場(chǎng)景是不一樣的,v-model更多的是接收用戶輸入,而.sync更多的是同步數(shù)據(jù).

怎么樣實(shí)現(xiàn)一個(gè)可以使用v-model的組件

其實(shí)這個(gè)問題也很簡(jiǎn)單,只要仔細(xì)思考了上面兩個(gè)問題,應(yīng)該可以知道如何寫,下面我就拿項(xiàng)目中的這個(gè)例子來做一個(gè)介紹,這個(gè)組件的效果是這樣的,一個(gè)簡(jiǎn)單的switch開關(guān):

QQ20180429-133843-HD.gif-66.8kB
QQ20180429-133843-HD.gif-66.8kB

改造之前的代碼:

<template>
    <div class="switch-outer"
         :class="{'on':on,'off':!on}"
         @click="handleChange">
        <span class="text"
              v-show="on">{{onText}}</span>
        <span class="text"
              v-show="!on">{{offText}}</span>
        <span class="active-ball"></span>
    </div>
</template>
<script>
export default {
    data() {
        return {
            on: this.isOn
        };
    },
    props: {
        onText: {
            type: String,
            default: '開啟'
        },
        offText: {
            type: String,
            default: '關(guān)閉'
        },
        isOn: {
            type: Boolean,
            default: true
        }
    },
    methods: {
        handleChange() {
            this.on = !this.on;
            this.$emit('change', this.on);
        }
    },
    watch: {
        isOn() {
            this.on = this.isOn;
        }
    }
};
</script>
<style rel="stylesheet/scss" lang="scss" scoped>
.switch-outer {
    position: absolute;
    cursor: pointer;
    color: #ffffff;

    .active-ball {
        width: 28px;
        height: 28px;
        border-radius: 50%;
        background-color: currentColor;
        position: absolute;
        top: 1px;
    }
}

.on {
    background: #00a4ee;

    .active-ball {
        left: 53px;
        transition: all 0.5s ease;
    }

    .text {
        margin-left: 14px;
        font-size: 14px;
    }
}

.off {
    background: #c0ccda;

    .active-ball {
        left: 2px;
        transition: all 0.5s ease;
    }

    .text {
        margin-left: 44px;
        font-size: 14px;
    }
}
</style>

改造之前的代碼,并不能使用v-model來做雙向綁定,但是很顯然,這是一個(gè)switch開關(guān),是一個(gè)用戶輸入組件,所以使用v-model是很自然的需求,但是目前這個(gè)組件的使用方式是這樣的

 <sky-switch class="share-switch"
            @change="handleChange"
            :isOn="group.is_files_share"
            ref="shareSwitch"></sky-switch>
// 手動(dòng)監(jiān)聽change事件,修改數(shù)據(jù)
handleChange(on) {
    this.group.is_files_share = on;
}

我們需要自己監(jiān)聽change事件,手動(dòng)的修改值,這顯然不符合我們對(duì)用戶輸入組件的認(rèn)知,我們需要一個(gè)像<input>那樣的組件,通過 v-model 來綁定數(shù)據(jù),剩下的交給vue來幫助我們處理.

顯然這種使用方式并不友好,不能稱為一個(gè)合格的組件.如果沒有文檔,我需要看源碼才能知道這個(gè)組件如何使用,如果源碼寫的十分復(fù)雜,這個(gè)組件基本上是不可復(fù)用的.

接下來我們就開始魔改這個(gè)組件代碼,刪除不必要的監(jiān)聽和屬性,簡(jiǎn)單直接的利用v-model來實(shí)現(xiàn)這個(gè)功能

改造后的代碼

<template>
    <div class="switch-outer"
         :class="{'on':on,'off':!on}"
         @click="handleChange">
        <span class="text"
              v-show="on">{{onText}}</span>
        <span class="text"
              v-show="!on">{{offText}}</span>
        <span class="active-ball"></span>
    </div>
</template>
<script>
export default {
    props: {
        onText: {
            type: String,
            default: '開啟'
        },
        offText: {
            type: String,
            default: '關(guān)閉'
        },
        value: {  // 將 isOn改成 value ,用來接收 v-model 的傳值
            type: Boolean,
            default: true
        }
    },
    methods: {
        handleChange() {
            this.on = !this.on;  // 通過賦值操作來觸發(fā)屬性 on 的 set 方法
            this.$emit('change', this.on); // 發(fā)送 change 事件,作為一個(gè)事件鉤子,方便用戶處理自己的邏輯
        }
    },
    computed: {
        on: {  // 去掉了data里面的on,使用計(jì)算屬性
            get() {  // get時(shí)返回 value值
                return this.value; 
            },
            set(val) { // set時(shí)發(fā)送 input 事件
                this.$emit('input', val);
            }
        }
    }
};
</script>
<style rel="stylesheet/scss" lang="scss" scoped>
.switch-outer {
    position: absolute;
    cursor: pointer;
    color: #ffffff;
    .active-ball {
        width: 28px;
        height: 28px;
        border-radius: 50%;
        background-color: currentColor;
        position: absolute;
        top: 1px;
        transition: all 0.5s ease;
    }
    transition: all 0.5s ease;
}

.on {
    background: #00a4ee;
    .active-ball {
        left: 53px;
        transition: all 0.5s ease;
    }
    .text {
        margin-left: 14px;
        font-size: 14px;
        transition: all 0.5s ease;
    }
}

.off {
    background: #c0ccda;
    .active-ball {
        left: 2px;
    }
    .text {
        margin-left: 44px;
        font-size: 14px;
        transition: all 0.5s ease;
    }
}
</style>

這段代碼的核心是那個(gè)計(jì)算屬性on,巧妙的通過計(jì)算屬性的getset方法,實(shí)現(xiàn)監(jiān)聽數(shù)據(jù)變化,get時(shí)返回通過props傳入的value,set時(shí),向父組件發(fā)送input事件,這樣就可以配合v-model來使用了,因?yàn)?code>v-model的本質(zhì)就是向組件傳一個(gè)valueprop,并且監(jiān)聽input方法[2]

style部分做了微調(diào),因?yàn)檫@里加入了動(dòng)畫,但是原來的動(dòng)畫只有部分值是動(dòng)的,會(huì)顯得很突兀,所以調(diào)整為所有變化的屬性都有動(dòng)畫,這樣整個(gè)動(dòng)畫變得很平滑.

改造后的組件,使用方式是這樣的:

<sky-switch class="share-switch" v-model="group.share_file"></sky-switch>

簡(jiǎn)單明了,一看就是一個(gè)用戶輸入組件,和<input>元素一樣.

當(dāng)然,這個(gè)組件還不夠完善,API接口也沒有很好的設(shè)計(jì),但是用來說明v-model這個(gè)問題應(yīng)該是足夠了.

寫在最后

沒事多重構(gòu)自己的點(diǎn),也可以重構(gòu)別人的代碼,看看別人是怎么實(shí)現(xiàn)的,自己又能怎么實(shí)現(xiàn),相互對(duì)比,學(xué)習(xí),這樣才能快速進(jìn)步.
前兩天有事情,清了一天假,項(xiàng)目進(jìn)度有點(diǎn)落后,今天過來補(bǔ)點(diǎn)進(jìn)度,剩下點(diǎn)時(shí)間,寫了這篇文字,雖然是一個(gè)很小的點(diǎn),但是,希望能對(duì)對(duì)個(gè)別人有所啟發(fā).


  1. 這里只是簡(jiǎn)單的說,其實(shí)由什么屬性和事件組成,可以通過一個(gè)model參數(shù)來定制 ?

  2. 這里依然是從簡(jiǎn)單的角度來說. ?

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末钧萍,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子费封,更是在濱河造成了極大的恐慌同欠,老刑警劉巖狰晚,帶你破解...
    沈念sama閱讀 216,591評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡裳食,警方通過查閱死者的電腦和手機(jī)玫恳,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,448評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門辨赐,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人纽窟,你說我怎么就攤上這事肖油。” “怎么了臂港?”我有些...
    開封第一講書人閱讀 162,823評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵森枪,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我审孽,道長(zhǎng)县袱,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,204評(píng)論 1 292
  • 正文 為了忘掉前任佑力,我火速辦了婚禮式散,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘打颤。我一直安慰自己暴拄,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,228評(píng)論 6 388
  • 文/花漫 我一把揭開白布编饺。 她就那樣靜靜地躺著乖篷,像睡著了一般。 火紅的嫁衣襯著肌膚如雪透且。 梳的紋絲不亂的頭發(fā)上撕蔼,一...
    開封第一講書人閱讀 51,190評(píng)論 1 299
  • 那天,我揣著相機(jī)與錄音秽誊,去河邊找鬼鲸沮。 笑死,一個(gè)胖子當(dāng)著我的面吹牛锅论,可吹牛的內(nèi)容都是我干的讼溺。 我是一名探鬼主播,決...
    沈念sama閱讀 40,078評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼棍厌,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼肾胯!你這毒婦竟也來了竖席?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,923評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤敬肚,失蹤者是張志新(化名)和其女友劉穎毕荐,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體艳馒,經(jīng)...
    沈念sama閱讀 45,334評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡憎亚,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,550評(píng)論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了弄慰。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片第美。...
    茶點(diǎn)故事閱讀 39,727評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖陆爽,靈堂內(nèi)的尸體忽然破棺而出什往,到底是詐尸還是另有隱情,我是刑警寧澤慌闭,帶...
    沈念sama閱讀 35,428評(píng)論 5 343
  • 正文 年R本政府宣布别威,位于F島的核電站,受9級(jí)特大地震影響驴剔,放射性物質(zhì)發(fā)生泄漏省古。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,022評(píng)論 3 326
  • 文/蒙蒙 一丧失、第九天 我趴在偏房一處隱蔽的房頂上張望豺妓。 院中可真熱鬧,春花似錦布讹、人聲如沸琳拭。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,672評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽臀栈。三九已至,卻和暖如春挠乳,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背姑躲。 一陣腳步聲響...
    開封第一講書人閱讀 32,826評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工睡扬, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人黍析。 一個(gè)月前我還...
    沈念sama閱讀 47,734評(píng)論 2 368
  • 正文 我出身青樓卖怜,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親阐枣。 傳聞我的和親對(duì)象是個(gè)殘疾皇子马靠,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,619評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • 1.ios高性能編程 (1).內(nèi)層 最小的內(nèi)層平均值和峰值(2).耗電量 高效的算法和數(shù)據(jù)結(jié)構(gòu)(3).初始化時(shí)...
    歐辰_OSR閱讀 29,373評(píng)論 8 265
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理奄抽,服務(wù)發(fā)現(xiàn),斷路器甩鳄,智...
    卡卡羅2017閱讀 134,652評(píng)論 18 139
  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,077評(píng)論 25 707
  • 轉(zhuǎn)輪王做為地府的高級(jí)領(lǐng)導(dǎo)逞度,辦事還是很有效率的。不一會(huì)妙啃,地府淘寶就傳來了短信档泽。 “你拍的幽冥玻尿酸已經(jīng)發(fā)送給嫦娥,現(xiàn)...
    可可豆子閱讀 336評(píng)論 0 5
  • 用戶URL請(qǐng)求 調(diào)用應(yīng)用入口文件(通常是網(wǎng)站的index.php) 載入框架入口文件(ThinkPHP.php) ...
    提莫隊(duì)長(zhǎng)1234閱讀 1,860評(píng)論 0 4