vue開發公共組件并發布到npm

寫在前面

作為一名合格的前端開發,想必大家都會有過這樣的煩惱:上個項目寫過這個功能(組件),這個項目又有相似的需求,又要擼一遍,費時費力還煩人。。。于是我想到了做成公共組件發布到npm上,下個項目使用時直接npm install xxx豈不是美滋滋?想法已經有了,那就開始著手干吧~~

\color{red}{本博客以創建一個element-ui公共提示信息組件為例~}
\color{red}{項目名稱:public-element-prompt-component}

一、搭建精簡版(webpack-simple)vue開發模板

注:隨著vue-cli3的發布,vue init webpack/webpack-simple xxx的語法已經被新版 vue create xxx所取代,因此,如果你使用的是vue-cli3,需要先行安裝@vue/cli-init以便使用vue-cli 2.x版本語法:
vue -V //查看vue-cli版本
npm install -g @vue/cli-init //全局安裝@vue/cli-init

官方參考文檔:傳送門

開始創建vue開發模板:
vue init webpack-simple public-element-prompt-component //創建webpack-simple模板項目

創建成功圖示如下:

image.png

創建完成后進入項目目錄,安裝相關依賴 (cnpm install),并運行(npm run dev)測試項目是否成功運行。出現以下界面則表示項目創建成功:
image.png

image.png

二、開始開發組件

src目錄下新建文件夾(名字隨意),并新建一個.vue文件,圖示如下:

image.png

文件代碼如下:

<template>
    <div class="PublicComponent"></div>
</template>

<script>
export default {
    name: 'PublicComponent',
    data() {
        return {

        }
    },
    props:{
        msgConfig:Object,
        confirmConfig:Object,
        promptConfig:Object
    },
    watch: {
        msgConfig: function (val, oldVal) {
            if (val != oldVal) {
                this.showMassage(val);
            }
        },
        confirmConfig: function (val, oldVal) {
            if (val != oldVal) {
                this.showConfirmModal(val);
            }
        },
        promptConfig: function (val, oldVal) {
            if (val != oldVal) {
                this.showPromptModal(val);
            }
        }
    },
    methods: {
        showMassage(config) {
            this.$message(config);
        },
        showConfirmModal(config) {
            this.$confirm(config.message, config.title, config.options ? config.options : {}).then(config.yesCallback).catch(config.cancelCallback ? config.cancelCallback : () => { });
        },
        showPromptModal(config) {
            this.$prompt(config.message, config.title, config.options ? config.options : {}).then(config.yesCallback).catch(config.cancelCallback ? config.cancelCallback : () => { });
        }
    }
}
</script>

三、在組件平級目錄下新增index.js文件

代碼如下:

import PublicComponent from './PublicComponent.vue'

// Declare install function executed by Vue.use()
export function install(Vue) {
    if (install.installed) return;
    install.installed = true;
    Vue.component('PublicComponent', PublicComponent);
}

// Create module definition for Vue.use()
const plugin = {
    install,
};

// Auto-install when vue is found (eg. in browser via <script> tag)
let GlobalVue = null;
if (typeof window !== 'undefined') {
    GlobalVue = window.Vue;
} else if (typeof global !== 'undefined') {
    GlobalVue = global.Vue;
}
if (GlobalVue) {
    GlobalVue.use(plugin);
}

export default PublicComponent;

官網參考文檔:傳送門

四、修改package.json等配置文件

package.json文件配置圖示如下:

image.png

webpack.config.js文件配置,主要修改入口(entry)及出口信息(output):

···
module.exports = {
 // entry: './src/main.js',
  entry: './src/component/index.js',
  output: {
      path: path.resolve(__dirname, './dist'),
      publicPath: '/dist/',
      // filename: 'build.js'
      filename: 'public-component.js',//與package.json中main相對應
      library: 'Public-component',
      libraryTarget: 'umd',
      umdNamedDefine: true
  }
...
}

相關配置參考:傳送門

五、打包測試

以上步驟完成后,我們可以進行打包測試了:

npm run build //打包

打包完成圖示如下:


image.png

六、發布到npm

首先你需要擁有一個npm賬號!需要擁有一個npm賬號!擁有一個npm賬號!
重要的事情說三遍~~
附上npm賬號注冊地址:傳送門

賬號注冊完成后就是發布流程了:

npm login //登錄npm,需要正確填寫用戶名、密碼及郵箱

npm publish //發布到npm

發布成功圖示如下:
image.png

七、測試使用組件

發布成功后,你的注冊郵箱會受到來自npm的郵件,提示你的npm包已經成功發布。這時候我們可以去npmcnpm搜索上傳的包:
npm地址:傳送門
cnpm地址:傳送門

image.png

在其他項目中使用該組件:

cnpm install public-element-prompt-component --save-dev  //安裝發布的npm包

用于測試的test項目,目錄如下:

image.png

由于項目依賴于element-ui,因此main.js需要進行修改
相關靜態資源文件,如index.css,字體文件等,請放在static目錄下,并在index.html中引入。mian.js具體代碼如下:

import Vue from 'vue'
import App from './App.vue'
import { Button, Message, MessageBox } from 'element-ui';

Vue.use(Button);

Vue.prototype.$message = Message;
Vue.prototype.$confirm = MessageBox.confirm;
Vue.prototype.$prompt = MessageBox.prompt;


Vue.config.productionTip = false

new Vue({
    render: h => h(App),
}).$mount('#app')

App.vue代碼如下:

<template>
    <div class="hello">
        <el-button @click="showComponent" type="danger" plain>刪除</el-button>
        <publicComponent :msgConfig="publicComponentObj.msgConfig" :confirmConfig="publicComponentObj.confirmConfig"></publicComponent>
    </div>
</template>

<script>
import PublicComponent from 'public-element-prompt-component'
export default {
    name: 'HelloWorld',
    props: {
        msg: String
    },
    data() {
        return {
            publicComponentObj: {
                confirmConfig: {},
                msgConfig: {},
            }
        }
    },
    methods: {
        showComponent() {
            const tempObj = {
                message: `確認移出選中成員嗎?`,
                title: '提示',
                options: {
                    type: 'warning'
                },
                yesCallback: () => {
                    const tempMsgObj = {
                        message: '刪除成功',
                        type: 'success',
                        showClose: true,
                        duration: 3000
                    }
                    this.publicComponentObj.msgConfig = tempMsgObj;
                }
            }
            this.publicComponentObj.confirmConfig = tempObj;
        }
    },
    components: {
        PublicComponent
    }
}
</script>

<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>

</style>

執行效果如下:

image.png

image.png

\color{red}{注:相關vue-cli3新建項目請參考以下官方文檔:}

官方文檔:傳送門

結束語

后續如果有版本更新,只需要修改package.json中的版本號重新發布即可~~

以上就是關于開發vue公共組件并發布到npm的操作步驟,有什么不足之處希望大家不吝評價~~
水平有限,各位看官不要嫌棄哈~~
\color{red}{最后附上github地址:}傳送門

感謝瀏覽~

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

推薦閱讀更多精彩內容