手把手教你封裝一個vue component

項(xiàng)目地址:vue-countTo
配套完整后臺demo地址:vue-element-admin
系類文章一:手摸手,帶你用vue擼后臺 系列一(基礎(chǔ)篇)
系類文章二:手摸手奋姿,帶你用vue擼后臺 系列二(登錄權(quán)限篇)
系類文章三:手摸手逸尖,帶你用vue擼后臺 系列三(實(shí)戰(zhàn)篇)
系類文章四:手摸手古沥,帶你用vue擼后臺 系列四(vueAdmin 一個極簡的后臺基礎(chǔ)模板)
系類文章:手摸手,帶你優(yōu)雅的使用 icon

為什么選擇自己封裝第三方庫

最近幾個月我司把之前兩三年的所有業(yè)務(wù)都用了 vue 重構(gòu)了一遍冷溶,前臺使用 vue+ssr渐白,后臺使用了 vue+element,在此過程中封裝和自己寫了很多 vue component逞频。其實(shí)vue 寫 component 相當(dāng)簡單和方便,github上有很多的 vue component 都只是簡單的包裝了一些 jquery 或者原生 js 的插件栋齿,但我個人是不太喜歡使用這些第三方封裝的苗胀。理由如下:

  1. 很多第三方封裝的組件參數(shù)配置項(xiàng)其實(shí)是有缺損的。如一些富文本或者圖表組件瓦堵,配置項(xiàng)遠(yuǎn)比你想想中的多得多基协,第三方封裝組件很難覆蓋全部所有配置。
  2. 第三方組件的更新頻率很難保證菇用。很多第三方封裝組件并不能一直和原始組件保持同步更新速度澜驮,萬一原始組件更新了某個你需要的功能,但第三方并沒有更新那豈不是很尷尬惋鸥,而且很多第三方組件維護(hù)一段時間之后就不維護(hù)了杂穷。
  3. 靈活性和針對性。還是那富文本來說卦绣,富文本在我司有很多定制化需求耐量,我們需要將圖片上傳七牛,需要將圖片打水印滤港,需要很多針對業(yè)務(wù)的特殊需求廊蜒,使用第三方包裝的組件是不合適的,一般基于第三方封裝的組件是很難拓展的溅漾。

所以我覺得大部分組件還是自己封裝來的更為方便和靈活一些山叮。

動手開干

接下來我們一起手摸手教改造包裝一個js插件,只要幾分鐘就可以封裝一個專屬于你的 vue component添履。封裝對象:countUp.js屁倔,改造后結(jié)果 vue-countTo

首先我們用官方提供的 vue-cli 來構(gòu)建項(xiàng)目 這里選擇了 webpack-simple (組件相對而言比較簡單缝龄,不需要很多復(fù)雜的功能汰现,所以 webpack-simple 已經(jīng)滿足需求了)

$ npm install -g vue-cli
$ vue init webpack-simple my-project
$ cd my-project
$ npm install

安裝countup.js

$ npm install countup.js
$ npm run dev

啟動項(xiàng)目之后按照 countup.js 官方 demo 初始化插件

app.vue

<template>
  <span ref='countup'></span>
</template>

<script>
import CountUp from 'countup.js'
export default {
  name: 'countup-demo',
  data () {
    return {
      numAnim:null
    }
  },
  mounted(){
    this.initCountUp()
  },
  methods:{
    initCountUp(){
      this.numAnim = new CountUp(this.$refs.countup,0, 2017)
      this.numAnim.start();
    }
  }
}
</script>

刷新頁面挂谍,就這么簡單,countUp.js 已經(jīng)生效了瞎饲。


接下來查看 countUp.js 的 github 發(fā)現(xiàn)它定義了如下可配置參數(shù)

對應(yīng) vue 就是 props口叙,類型和初始化一目了然。

props: {
  start: {
    type: Number,
    default: 0
  },
  end: {
    type: Number,
    default: 2017
  },
  decimal: {
    type: Number,
    default: 0
  },
  duration: {
    type: Number,
    default: 2.5
  },
  options: {
    type: Object
  }
}

之后再將countup之前寫死的配置項(xiàng)替換為動態(tài)props就可以了


this.numAnim = new CountUp(this.$refs.countup, 
                           this.start,
                           this.end,
                           this.decimal,
                           this.duration,
                           this.options)

使用組件

<vue-count-up :end="2500" :duration="2.5"></vue-count-up>

只要幾分鐘一個屬于自己的原生組件就包裝好了嗅战,就是這么簡單妄田。完整demo
這時候你如果覺得使用countUp.js 還有些不滿足你的需求,那你可以選擇自己來造輪子了驮捍。

造輪子篇

首先當(dāng)然是閱讀源碼
其實(shí)源碼也就兩部分核心代碼
第一部分:主要是就是 requestAnimationFrame疟呐,在游覽器不支持requestAnimationFrame 的情況下使用 setTimeout來模擬,這段代碼值得仔細(xì)閱讀东且,自己在平時的項(xiàng)目中也能借鑒使用這段代碼启具。
第二部分:就是 count 函數(shù)
看懂這兩部分之后造輪子就相當(dāng)?shù)暮唵瘟? demo

造輪子過程中發(fā)現(xiàn) countUp,并沒有 autoplay 這個參數(shù)項(xiàng)可以讓組件自動開始count,沒關(guān)系珊泳。鲁冯。。我們可以自己來擼色查,我們首先定義 autoplay 這個props為布爾值薯演,默認(rèn)所有組件 autoplay 為 true

 props:{
   autoplay: {
     type: Boolean,
     required: false,
     default: true
   }
 }

定義好 props 之后只要在 mounted 生命周期內(nèi)加一個判斷就完事了。

mounted() {
  if (this.autoplay) {
    this.start();
  }
}

我們的 countUp 組件可以自動 count 了秧了!


上傳 npm

在不跨項(xiàng)目的情況下之前所做的已經(jīng)滿足需求了跨扮。但我們不能就此滿足,我想讓世界上更多的人來使用我的插件验毡,這時候就要上傳 npmdemo 衡创。

首先我們新建一個index.js

import CountTo from './vue-countTo.vue'

// 導(dǎo)出模塊
export default CountTo

//global 情況下 自動安裝
if (typeof window !== 'undefined' && window.Vue) {
  window.Vue.component('count-to', CountTo)
}

同時我們也要改造一下 webpack 的配置,因?yàn)椴皇撬惺褂媚憬M件的人都是通過 npm 安裝使用 import 引入組件的的米罚。

還有很多人是通過 <script> 標(biāo)簽的方式直接引入的钧汹,所以我們要將 libraryTarget改為 umd 格式

library: 'CountTo',
libraryTarget: 'umd',
umdNamedDefine: true

大功告成,現(xiàn)在只要將它發(fā)布到 npm 就可以了录择,首先注冊一個npm 賬號拔莱,
之后配置自己的 package.json (注意填寫 version,每次發(fā)布的 version 不能相同隘竭;main 為入口文件地址)塘秦。
之后只要一行命令 npm publish 你的項(xiàng)目就發(fā)到 npm 了,快讓小伙伴們一起來用你的vue component 吧动看!

image.png

總結(jié)

這里這是拿了一個很簡單的 countUp 組件舉了一個簡單例子尊剔,有的時候自己動手豐衣足食,很多插件的封裝比想象中簡單的多菱皆。產(chǎn)品經(jīng)理再也不會看到我因?yàn)檫@個fu**插件怎么不支持這個功能而愁眉苦臉了须误,我們可以更好地滿足產(chǎn)品了~~
完整項(xiàng)目地址:https://github.com/PanJiaChen/vue-countTo 歡迎 star

占坑

常規(guī)占坑挨稿,這里是手摸手,帶你用vue擼后臺系類
完整項(xiàng)目地址:vue-element-admin
系類文章一:手摸手京痢,帶你用vue擼后臺 系列一(基礎(chǔ)篇)
系類文章二:手摸手奶甘,帶你用vue擼后臺 系列二(登錄權(quán)限篇)
系類文章三:手摸手,帶你用vue擼后臺 系列三(實(shí)戰(zhàn)篇)
系類文章四:手摸手祭椰,帶你用vue擼后臺 系列四(vueAdmin 一個極簡的后臺基礎(chǔ)模板)
系類文章:手摸手臭家,帶你優(yōu)雅的使用 icon
樓主個人免費(fèi)圈子

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末方淤,一起剝皮案震驚了整個濱河市钉赁,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌携茂,老刑警劉巖你踩,帶你破解...
    沈念sama閱讀 216,372評論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異讳苦,居然都是意外死亡姓蜂,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評論 3 392
  • 文/潘曉璐 我一進(jìn)店門医吊,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人逮京,你說我怎么就攤上這事卿堂。” “怎么了懒棉?”我有些...
    開封第一講書人閱讀 162,415評論 0 353
  • 文/不壞的土叔 我叫張陵草描,是天一觀的道長。 經(jīng)常有香客問我策严,道長穗慕,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,157評論 1 292
  • 正文 為了忘掉前任妻导,我火速辦了婚禮逛绵,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘倔韭。我一直安慰自己术浪,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,171評論 6 388
  • 文/花漫 我一把揭開白布寿酌。 她就那樣靜靜地躺著胰苏,像睡著了一般。 火紅的嫁衣襯著肌膚如雪醇疼。 梳的紋絲不亂的頭發(fā)上硕并,一...
    開封第一講書人閱讀 51,125評論 1 297
  • 那天法焰,我揣著相機(jī)與錄音,去河邊找鬼倔毙。 笑死埃仪,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的普监。 我是一名探鬼主播贵试,決...
    沈念sama閱讀 40,028評論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼凯正!你這毒婦竟也來了毙玻?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,887評論 0 274
  • 序言:老撾萬榮一對情侶失蹤廊散,失蹤者是張志新(化名)和其女友劉穎桑滩,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體允睹,經(jīng)...
    沈念sama閱讀 45,310評論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡运准,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,533評論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了缭受。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片胁澳。...
    茶點(diǎn)故事閱讀 39,690評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖米者,靈堂內(nèi)的尸體忽然破棺而出韭畸,到底是詐尸還是另有隱情,我是刑警寧澤蔓搞,帶...
    沈念sama閱讀 35,411評論 5 343
  • 正文 年R本政府宣布胰丁,位于F島的核電站,受9級特大地震影響喂分,放射性物質(zhì)發(fā)生泄漏锦庸。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,004評論 3 325
  • 文/蒙蒙 一蒲祈、第九天 我趴在偏房一處隱蔽的房頂上張望甘萧。 院中可真熱鬧,春花似錦讳嘱、人聲如沸幔嗦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽邀泉。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間汇恤,已是汗流浹背庞钢。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評論 1 268
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留因谎,地道東北人基括。 一個月前我還...
    沈念sama閱讀 47,693評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像财岔,于是被迫代替她去往敵國和親风皿。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,577評論 2 353

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

  • 臺北的人給小離一種很特別的安全感魔眨,她不再懼怕這個陌生城市帶來的孤獨(dú)!就如歌詞所唱的冬季到臺北來看雨酿雪,對于人們來說雨...
    落花小離閱讀 182評論 0 2
  • 下午去理發(fā)遏暴,藏在巷子里的小理發(fā)店,只有一個理發(fā)師兼老板指黎,人稱劉姐朋凉。因?yàn)槔戆l(fā)技術(shù)不錯,我是這的老主顧醋安,也正因?yàn)榧夹g(shù)不...
    Mr__Pan閱讀 853評論 0 0