手把手帶你封裝一個(gè)vue component第三方庫
為什么選擇自己封裝第三方庫
最近幾個(gè)月我司把之前兩三年的所有業(yè)務(wù)都用了 vue 重構(gòu)了一遍,前臺(tái)使用 vue+ssr,后臺(tái)使用了 vue+element,在此過程中封裝和自己寫了很多 vue component。其實(shí)vue 寫 component 相當(dāng)簡(jiǎn)單和方便,github上有很多的 vue component 都只是簡(jiǎn)單的包裝了一些 jquery 或者原生 js 的插件,但我個(gè)人是不太喜歡使用這些第三方封裝的。理由如下:
- 很多第三方封裝的組件參數(shù)配置項(xiàng)其實(shí)是有缺損的。如一些富文本或者圖表組件,配置項(xiàng)遠(yuǎn)比你想想中的多得多,第三方封裝組件很難覆蓋全部所有配置。
- 第三方組件的更新頻率很難保證。很多第三方封裝組件并不能一直和原始組件保持同步更新速度,萬一原始組件更新了某個(gè)你需要的功能,但第三方并沒有更新那豈不是很尷尬,而且很多第三方組件維護(hù)一段時(shí)間之后就不維護(hù)了。
- 靈活性和針對(duì)性。還是那富文本來說,富文本在我司有很多定制化需求,我們需要將圖片上傳七牛,需要將圖片打水印,需要很多針對(duì)業(yè)務(wù)的特殊需求,使用第三方包裝的組件是不合適的,一般基于第三方封裝的組件是很難拓展的。
所以我覺得大部分組件還是自己封裝來的更為方便和靈活一些。
動(dòng)手開干
接下來我們一起手摸手教改造包裝一個(gè)js插件,只要幾分鐘就可以封裝一個(gè)專屬于你的 vue component。封裝對(duì)象:countUp.js,改造后結(jié)果vue-countTo。
首先我們用官方提供的vue-cli 來構(gòu)建項(xiàng)目 這里選擇了 webpack-simple (組件相對(duì)而言比較簡(jiǎn)單,不需要很多復(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
啟動(dòng)項(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>
刷新頁面,就這么簡(jiǎn)單,countUp.js 已經(jīng)生效了。
接下來查看 countUp.js 的 github 發(fā)現(xiàn)它定義了如下可配置參數(shù)
對(duì)應(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)替換為動(dò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>
只要幾分鐘一個(gè)屬于自己的原生組件就包裝好了,就是這么簡(jiǎn)單。完整demo
這時(shí)候你如果覺得使用countUp.js 還有些不滿足你的需求,那你可以選擇自己來造輪子了。
造輪子篇
首先當(dāng)然是閱讀源碼了
其實(shí)源碼也就兩部分核心代碼
第一部分:主要是就是 requestAnimationFrame
,在游覽器不支持requestAnimationFrame
的情況下使用 setTimeout
來模擬,這段代碼值得仔細(xì)閱讀,自己在平時(shí)的項(xiàng)目中也能借鑒使用這段代碼。
第二部分:就是 count 函數(shù)
看懂這兩部分之后造輪子就相當(dāng)?shù)暮?jiǎn)單了, demo
造輪子過程中發(fā)現(xiàn) countUp,并沒有 autoplay 這個(gè)參數(shù)項(xiàng)可以讓組件自動(dòng)開始count,沒關(guān)系。。。我們可以自己來擼,我們首先定義 autoplay 這個(gè)props為布爾值,默認(rèn)所有組件 autoplay 為 true
props:{ autoplay: { type: Boolean, required: false, default: true } }
定義好 props 之后只要在 mounted 生命周期內(nèi)加一個(gè)判斷就完事了。
mounted() { if (this.autoplay) { this.start(); } }
我們的 countUp 組件可以自動(dòng) count 了!
上傳 npm
在不跨項(xiàng)目的情況下之前所做的已經(jīng)滿足需求了。但我們不能就此滿足,我想讓世界上更多的人來使用我的插件,這時(shí)候就要上傳npm了 demo 。
首先我們新建一個(gè)index.js
import CountTo from './vue-countTo.vue' // 導(dǎo)出模塊 export default CountTo //global 情況下 自動(dòng)安裝 if (typeof window !== 'undefined' && window.Vue) { window.Vue.component('count-to', CountTo) }
同時(shí)我們也要改造一下 webpack 的配置,因?yàn)椴皇撬惺褂媚憬M件的人都是通過 npm 安裝使用 import 引入組件的的。
還有很多人是通過 <script>
標(biāo)簽的方式直接引入的,所以我們要將 libraryTarget
改為 umd 格式
library: 'CountTo', libraryTarget: 'umd', umdNamedDefine: true
大功告成,現(xiàn)在只要將它發(fā)布到 npm 就可以了,首先注冊(cè)一個(gè)npm 賬號(hào),
之后配置自己的 package.json (注意填寫 version,每次發(fā)布的 version 不能相同;main 為入口文件地址)。
之后只要一行命令 npm publish 你的項(xiàng)目就發(fā)到 npm 了,快讓小伙伴們一起來用你的vue component 吧!
總結(jié)
這里這是拿了一個(gè)很簡(jiǎn)單的 countUp 組件舉了一個(gè)簡(jiǎn)單例子,有的時(shí)候自己動(dòng)手豐衣足食,很多插件的封裝比想象中簡(jiǎn)單的多。產(chǎn)品經(jīng)理再也不會(huì)看到我因?yàn)檫@個(gè)fu**插件怎么不支持這個(gè)功能而愁眉苦臉了,我們可以更好地滿足產(chǎn)品了~~
完整項(xiàng)目地址:https://github.com/PanJiaChen/vue-countTo歡迎 star
完整項(xiàng)目地址:vue-element-admin
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Vue中虛擬DOM的簡(jiǎn)單實(shí)現(xiàn)
Vue中的虛擬DOM是通過JavaScript對(duì)象來描述真實(shí)DOM結(jié)構(gòu)的一種方式,本文將介紹Vue中虛擬DOM的簡(jiǎn)單實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下2023-05-05使用Karma做vue組件單元測(cè)試的實(shí)現(xiàn)
這篇文章主要介紹了使用Karma做vue組件單元測(cè)試的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-01-01Vue中使用方法、計(jì)算屬性或觀察者的方法實(shí)例詳解
這篇文章主要介紹了Vue中如何使用方法、計(jì)算屬性或觀察者的相關(guān)知識(shí),非常不錯(cuò),具有一定的參考借鑒價(jià)值 ,需要的朋友可以參考下2018-10-10Vue學(xué)習(xí)筆記進(jìn)階篇之函數(shù)化組件解析
本篇文章主要介紹了Vue學(xué)習(xí)筆記進(jìn)階篇之函數(shù)化組件探究,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-07-07vue-cli2.0轉(zhuǎn)3.0之項(xiàng)目搭建的詳細(xì)步驟
這篇文章主要介紹了vue-cli2.0轉(zhuǎn)3.0之項(xiàng)目搭建的詳細(xì)步驟,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-12-12element UI 2.15.13與vue2.0表格勾選回顯關(guān)鍵demo
這篇文章主要為大家介紹了element UI 2.15.13與vue2.0表格勾選回顯關(guān)鍵demo,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11vue post application/x-www-form-urlencoded如何實(shí)現(xiàn)傳參
這篇文章主要介紹了vue post application/x-www-form-urlencoded如何實(shí)現(xiàn)傳參問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-04-04