自定義Vue組件打包、發(fā)布到npm及使用教程
本文將幫助:將自己寫的Vue組件打包到npm進(jìn)行代碼托管,以及正常發(fā)布之后如何使用自己的組件。
本文講述的僅僅是最基礎(chǔ)的實(shí)現(xiàn),其他復(fù)雜的操作需要非常熟悉webpack的相關(guān)知識(shí),作者將繼續(xù)學(xué)習(xí)。
按照大佬文中寫的一步步操作,夠細(xì)心的話基本可以一步到位。下面總結(jié)一下發(fā)布步驟:
1. 利用Vue的腳手架新建一個(gè)簡(jiǎn)易版的Vue項(xiàng)目my-project:
vue init webpack-simple my-project -> cd my-project -> npm i -> npm run dev
2. 編寫組件:
src下新建myPlugin文件夾用于存放所以開發(fā)的組件 -> 為每一個(gè)組件創(chuàng)建一個(gè)文件夾,其中存放一個(gè)vue組件文件和一個(gè)index.js配置文件 -> 在myPlugin下的最外層創(chuàng)建一個(gè)入口配置文件 -> 為每個(gè)人vue組件文件中加上一個(gè)name屬性
3. 測(cè)試組件:
在app.vue中測(cè)試一下自己的組件可不可以用
4. 編寫配置文件
為剛剛加入的每個(gè)組件文件夾中的index.js放入如下代碼:(其中l(wèi)dcPagination為組件名)
import ldcPagination from './index.vue'; ldcPagination.install = Vue => Vue.component(ldcPagination.name, ldcPagination);//.name就是開始說(shuō)的vue文件暴露出來(lái)的name名,ldcPagination整個(gè)組件 export default ldcPagination;
為myPlugin下index.js放入如下代碼:(其中l(wèi)dcPagination為組件名,多個(gè)組件直接在components數(shù)組中加入并在最后輸出出來(lái)就行)(引入的公共樣式文件等都可以放這個(gè)文件中)
import ldcPagination from './Pagination/index.js'; const components = [ ldcPagination ] const install = function(Vue, opts = {}) { components.forEach(component => { Vue.component(component.name, component); }); } if (typeof window !== 'undefined' && window.Vue) { install(window.Vue); } export default { install, ldcPagination }
5. 改寫webpack.config.js配置文件
將其中的輸入輸出換成如下代碼:
var path = require('path') var webpack = require('webpack') const NODE_ENV = process.env.NODE_ENV; module.exports = { //entry: './src/main.js', //output: { // path: path.resolve(__dirname, './dist'), // publicPath: '/dist/', // filename: 'build.js' // }, entry: NODE_ENV == 'development' ? './src/main.js' : './src/myPlugin/index.js', output: { path: path.resolve(__dirname, './dist'), publicPath: '/dist/',//路徑 filename: 'ldc-ui.js',//打包之后的名稱 library: 'ldc-ui', // 指定的就是你使用require時(shí)的模塊名 libraryTarget: 'umd', // 指定輸出格式 umdNamedDefine: true // 會(huì)對(duì) UMD 的構(gòu)建過(guò)程中的 AMD 模塊進(jìn)行命名。否則就使用匿名的 define }, ... }
6. 發(fā)布前準(zhǔn)備
改寫package.json中的private為false,加入"main": "dist/ldc-ui.js
", 其他的自定義 -> 新建.npmignore文件忽略不需要上傳的文件如.* *.md *.yml build/ node_modules/ src/ test/
7. 發(fā)布
npm run build 打包 -> 注冊(cè)npm賬號(hào) -> npm login 登錄 -> npm publish 發(fā)布
可能出現(xiàn)問(wèn)題:
1. 登錄源錯(cuò)誤, npm config get registry 可查看當(dāng)前登錄源,npm config set registry=http://registry.npmjs.org 可切換到正確的登錄源
2. 版本號(hào)不能重復(fù)
3. 圖片資源打包后無(wú)法使用,所以自己的組件中不要使用
使用組件方式:
1. npm i xxx -D
2. import XXX from 'xxx'
3. const { A, B } = XXX
4. 在Vue中注冊(cè) components: { A, B }
總結(jié)
以上所述是小編給大家介紹的自定義Vue組件打包、發(fā)布到npm及使用教程,希望對(duì)大家有所幫助,如果大家有任何疑問(wèn)請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
如果你覺得本文對(duì)你有幫助,歡迎轉(zhuǎn)載,煩請(qǐng)注明出處,謝謝!
- Vue 組件封裝 并使用 NPM 發(fā)布的教程
- Vue cli3 庫(kù)模式搭建組件庫(kù)并發(fā)布到 npm的流程
- 詳解如何制作并發(fā)布一個(gè)vue的組件的npm包
- Vue.js構(gòu)建你的第一個(gè)包并在NPM上發(fā)布的方法步驟
- 一個(gè)vue組件庫(kù)發(fā)布到npm的完整實(shí)現(xiàn)過(guò)程
- vue3+vite自定義封裝vue組件發(fā)布到npm包的全過(guò)程
- vue組件打包并發(fā)布到npm的全過(guò)程
- vue使用npm發(fā)布自己的公網(wǎng)包
- vue組件發(fā)布成npm包
- vue3+webpack中npm發(fā)布組件的實(shí)現(xiàn)
相關(guān)文章
詳解vue項(xiàng)目首頁(yè)加載速度優(yōu)化
這篇文章主要介紹了詳解vue項(xiàng)目首頁(yè)加載速度優(yōu)化,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-10-10vue實(shí)現(xiàn)一個(gè)獲取按鍵展示快捷鍵效果的Input組件
這篇文章主要介紹了vue如何實(shí)現(xiàn)一個(gè)獲取按鍵展示快捷鍵效果的Input組件,幫助大家更好的理解和使用vue框架,感興趣的朋友可以了解下2021-01-01Vue生產(chǎn)環(huán)境如何自動(dòng)屏蔽console
這篇文章主要介紹了Vue生產(chǎn)環(huán)境如何自動(dòng)屏蔽console問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-06-06vue項(xiàng)目中實(shí)現(xiàn)的微信分享功能示例
這篇文章主要介紹了vue項(xiàng)目中實(shí)現(xiàn)的微信分享功能,結(jié)合實(shí)例形式分析了基于vue.js實(shí)現(xiàn)的微信分享功能具體定義與使用方法,需要的朋友可以參考下2019-01-01淺談Vue.js 1.x 和 2.x 實(shí)例的生命周期
下面小編就為大家?guī)?lái)一篇淺談Vue.js 1.x 和 2.x 實(shí)例的生命周期。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-07-07vue實(shí)現(xiàn)在線預(yù)覽pdf文件和下載(pdf.js)
這篇文章主要為大家詳細(xì)介紹了vue實(shí)現(xiàn)在線預(yù)覽pdf文件和下載,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-11-11vue.js 子組件無(wú)法獲取父組件store值的解決方式
今天小編就為大家分享一篇vue.js 子組件無(wú)法獲取父組件store值的解決方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2019-11-11vue使用微信JS-SDK實(shí)現(xiàn)分享功能
這篇文章主要介紹了vue使用微信JS-SDK實(shí)現(xiàn)分享功能,本文給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-08-08vue使用element-resize-detector監(jiān)聽元素寬度變化方式
這篇文章主要介紹了vue使用element-resize-detector監(jiān)聽元素寬度變化方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-12-12