手把手帶你封裝一個(gè)vue component第三方庫(kù)
為什么選擇自己封裝第三方庫(kù)
最近幾個(gè)月我司把之前兩三年的所有業(yè)務(wù)都用了 vue 重構(gòu)了一遍,前臺(tái)使用 vue+ssr,后臺(tái)使用了 vue+element,在此過(guò)程中封裝和自己寫(xiě)了很多 vue component。其實(shí)vue 寫(xiě) component 相當(dāng)簡(jiǎn)單和方便,github上有很多的 vue component 都只是簡(jiǎn)單的包裝了一些 jquery 或者原生 js 的插件,但我個(gè)人是不太喜歡使用這些第三方封裝的。理由如下:
- 很多第三方封裝的組件參數(shù)配置項(xiàng)其實(shí)是有缺損的。如一些富文本或者圖表組件,配置項(xiàng)遠(yuǎn)比你想想中的多得多,第三方封裝組件很難覆蓋全部所有配置。
- 第三方組件的更新頻率很難保證。很多第三方封裝組件并不能一直和原始組件保持同步更新速度,萬(wàn)一原始組件更新了某個(gè)你需要的功能,但第三方并沒(méi)有更新那豈不是很尷尬,而且很多第三方組件維護(hù)一段時(shí)間之后就不維護(hù)了。
- 靈活性和針對(duì)性。還是那富文本來(lái)說(shuō),富文本在我司有很多定制化需求,我們需要將圖片上傳七牛,需要將圖片打水印,需要很多針對(duì)業(yè)務(wù)的特殊需求,使用第三方包裝的組件是不合適的,一般基于第三方封裝的組件是很難拓展的。
所以我覺(jué)得大部分組件還是自己封裝來(lái)的更為方便和靈活一些。
動(dòng)手開(kāi)干
接下來(lái)我們一起手摸手教改造包裝一個(gè)js插件,只要幾分鐘就可以封裝一個(gè)專屬于你的 vue component。封裝對(duì)象:countUp.js,改造后結(jié)果vue-countTo。
首先我們用官方提供的vue-cli 來(lái)構(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>
刷新頁(yè)面,就這么簡(jiǎn)單,countUp.js 已經(jīng)生效了。

接下來(lái)查看 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ě)死的配置項(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í)候你如果覺(jué)得使用countUp.js 還有些不滿足你的需求,那你可以選擇自己來(lái)造輪子了。
造輪子篇
首先當(dāng)然是閱讀源碼了
其實(shí)源碼也就兩部分核心代碼
第一部分:主要是就是 requestAnimationFrame,在游覽器不支持requestAnimationFrame 的情況下使用 setTimeout 來(lái)模擬,這段代碼值得仔細(xì)閱讀,自己在平時(shí)的項(xiàng)目中也能借鑒使用這段代碼。
第二部分:就是 count 函數(shù)
看懂這兩部分之后造輪子就相當(dāng)?shù)暮?jiǎn)單了, demo
造輪子過(guò)程中發(fā)現(xiàn) countUp,并沒(méi)有 autoplay 這個(gè)參數(shù)項(xiàng)可以讓組件自動(dòng)開(kāi)始count,沒(méi)關(guān)系。。。我們可以自己來(lái)擼,我們首先定義 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)滿足需求了。但我們不能就此滿足,我想讓世界上更多的人來(lái)使用我的插件,這時(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件的人都是通過(guò) npm 安裝使用 import 引入組件的的。
還有很多人是通過(guò) <script> 標(biāo)簽的方式直接引入的,所以我們要將 libraryTarget 改為 umd 格式
library: 'CountTo', libraryTarget: 'umd', umdNamedDefine: true
大功告成,現(xiàn)在只要將它發(fā)布到 npm 就可以了,首先注冊(cè)一個(gè)npm 賬號(hào),
之后配置自己的 package.json (注意填寫(xiě) version,每次發(fā)布的 version 不能相同;main 為入口文件地址)。
之后只要一行命令 npm publish 你的項(xiàng)目就發(fā)到 npm 了,快讓小伙伴們一起來(lái)用你的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.js云存儲(chǔ)實(shí)現(xiàn)圖片上傳功能
示對(duì)象存儲(chǔ)是騰訊云提供的一種存儲(chǔ)海量文件的分布式存儲(chǔ)服務(wù),本文主要介紹了用vue.js實(shí)現(xiàn)圖片上傳功能,感興趣的小伙伴們可以參考一下2021-05-05
vue中使用jquery滑動(dòng)到頁(yè)面底部的實(shí)現(xiàn)方式
這篇文章主要介紹了vue中使用jquery滑動(dòng)到頁(yè)面底部的實(shí)現(xiàn)方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-12-12
vue3實(shí)戰(zhàn)-子組件之間相互傳值問(wèn)題
這篇文章主要介紹了vue3實(shí)戰(zhàn)-子組件之間相互傳值問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-03-03
VUE2 前端實(shí)現(xiàn) 靜態(tài)二級(jí)省市聯(lián)動(dòng)選擇select的示例
下面小編就為大家分享一篇VUE2 前端實(shí)現(xiàn) 靜態(tài)二級(jí)省市聯(lián)動(dòng)選擇select的示例。具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-02-02
Vue3中watchEffect和watch的基礎(chǔ)應(yīng)用詳解
watch是一個(gè)偵聽(tīng)器,默認(rèn)是懶偵聽(tīng)的,即僅在偵聽(tīng)源發(fā)生變化時(shí)才執(zhí)行回調(diào)函數(shù),watchEffect是會(huì)自動(dòng)收集函數(shù)里面變量的響應(yīng)式依賴,本文主要來(lái)講講二者的區(qū)別,感興趣的可以了解一下2023-07-07
在Vue中實(shí)現(xiàn)二維碼生成與掃描功能的方法
二維碼是一種廣泛應(yīng)用于各種場(chǎng)合的編碼方式,它可以將信息編碼成一張二維圖案,方便快捷地傳遞信息,在Vue.js中,我們可以使用一些庫(kù)和組件來(lái)實(shí)現(xiàn)二維碼的生成和掃描,本文將介紹如何在Vue中實(shí)現(xiàn)二維碼的生成和掃描的方法2023-06-06
uni-app中vue3表單校驗(yàn)失敗的問(wèn)題及解決方法
最近遇到這樣的問(wèn)題在app中使用uni-forms表單,并添加校驗(yàn)規(guī)則,問(wèn)題是即使輸入內(nèi)容,表單校驗(yàn)依然失敗,本文給大家分享uni-app中vue3表單校驗(yàn)失敗的問(wèn)題及解決方法,感興趣的朋友一起看看吧2023-12-12
vscode中eslint配置保存自動(dòng)修復(fù)代碼示例詳解
vscode根據(jù)eslint保存?動(dòng)修復(fù)配置,下面這篇文章主要給大家介紹了關(guān)于vscode中eslint配置保存自動(dòng)修復(fù)代碼的相關(guān)資料,文中通過(guò)圖文介紹的非常詳細(xì),需要的朋友可以參考下2023-12-12

