Vue 組件封裝 并使用 NPM 發(fā)布的教程
正文開始
Vue 開發(fā)插件
我們可以先查看Vue的插件的開發(fā)規(guī)范
我們開發(fā)的之后期望的結(jié)果是支持 import、require 或者直接使用 script 標(biāo)簽的形式引入,就像這樣:
ps: 這里注意一下包的名字前綴是 unisoft ,組件的名字前綴是 uni
import UniSoftUI from 'unisoft-ui'; // 或者 const CustomUI = require('unisoft-ui'); // 或者 <script src="..."></script> Vue.use(UniSoftUI);
回到頂部
構(gòu)建一個 Vue 項(xiàng)目
開發(fā)組件我們使用 webpack-simple 模板:
vue init webpack-simple <project-name>
ps: 這里我選擇了 use sass 因?yàn)橹箝_發(fā)組件會用到
目錄結(jié)構(gòu)如圖:
├── src/ // 源碼目錄
│ ├── packages/ // 組件目錄
│ │ ├── switch/ // 組件(以switch為例)
│ │ ├── uni-switch.vue // 組件代碼
│ │ ├── index.js // 掛載插件
│ ├── App.vue // 頁面入口
│ ├── main.js // 程序入口
│ ├── index.js // (所有)插件入口
├── index.html // 入口html文件
開發(fā)單個組件:
先看一下目標(biāo)效果:
開始開發(fā):
在 packages 文件夾下新建一個 switch 文件夾用來存放 switch 組件的源碼,繼續(xù)在 switch 文件夾中新建 uni-switch.vue 和 index.js 文件
uni-switch.vue 組件:
<template> <div class="uni-switch"> <div class="wrapper"> <span><slot></slot></span> <div :class="[{closed: !checked}, 'switch-box']" @click="handleChange(value)"> <span :class="{closed: !checked}"></span> </div> <input type="checkbox" @change="handleChange" :true-value="activeValue" :false-value="inactiveValue" :disabled="disabled" :value="value"/> </div> </div> </template> <script> export default { name: "UniSwitch", data() { return {} }, props: { value: { type: [Boolean, String, Number], default: false }, activeValue: { type: [Boolean, String, Number], default: true }, inactiveValue: { type: [Boolean, String, Number], default: false }, disabled: { type: Boolean, default: false } }, computed: { checked() { return this.value === this.activeValue; } }, methods: { handleChange(value) { this.$emit('input', !this.checked ? this.activeValue : this.inactiveValue); } } } </script>
index.js:
// UniSwitch 是對應(yīng)組件的名字,要記得在 moor-switch.vue 文件中還是 name 屬性哦 import UniSwitch from './UniSwitch.vue'; UniSwitch.install = Vue => Vue.component(UniSwitch.name, UniSwitch); export default UniSwitch;
好了基本完成了,但是為了將所有的組件集中起來比如我還有 select、 input、 button 等組件,那么我想要統(tǒng)一將他們放在一個文件這中便于管理
所以在 App.vue 同級目錄我新建了一個 index.js 文件
import UniSwitch from './packages/switch/index'; import UniSlider from './packages/slider/index'; import UniNumberGrow from './packages/number-grow/index'; import './common/scss/reset.css' // ...如果還有的話繼續(xù)添加 const components = [ UniSwitch, UniSlider, UniNumberGrow // ...如果還有的話繼續(xù)添加 ] const install = function (Vue, opts = {}) { components.map(component => { Vue.component(component.name, component); }) } /* 支持使用標(biāo)簽的方式引入 */ if (typeof window !== 'undefined' && window.Vue) { install(window.Vue); } export default { install, UniSwitch, UniSlider, UniNumberGrow // ...如果還有的話繼續(xù)添加 }
好了到這里我們的組件就開發(fā)完成了;下面開始說怎么打包發(fā)布到 npm 上
發(fā)布到 npm
打包之前,首先我們需要改一下 webpack.config.js 這個文件;
// ... 此處省略代碼 const NODE_ENV = process.env.NODE_ENV module.exports = { // 根據(jù)不同的執(zhí)行環(huán)境配置不同的入口 entry: NODE_ENV == 'development' ? './src/main.js' : './src/index.js', output: { // 修改打包出口,在最外級目錄打包出一個 index.js 文件,我們 import 默認(rèn)會指向這個文件 path: path.resolve(__dirname, './dist'), publicPath: '/dist/', filename: 'custom-ui.js', library: 'custom-ui', // 指定的就是你使用require時的模塊名 libraryTarget: 'umd', // libraryTarget會生成不同umd的代碼,可以只是commonjs標(biāo)準(zhǔn)的,也可以是指amd標(biāo)準(zhǔn)的,也可以只是通過script標(biāo)簽引入的 umdNamedDefine: true // 會對 UMD 的構(gòu)建過程中的 AMD 模塊進(jìn)行命名。否則就使用匿名的 define }, // ... 此處省略代碼 }
然后, 再修改package.json 文件:
// 發(fā)布開源因此需要將這個字段改為 false "private": false, // 這個指 import custom-ui 的時候它會去檢索的路徑 "main": "dist/unisoft-ui.js",
發(fā)布命令只有兩步驟:
npm login // 登陸
npm publish // 發(fā)布
完成之后我們就可以在項(xiàng)目中安裝使用了
在項(xiàng)目中使用unisoft-ui
在自己的項(xiàng)目中使用unisoft-ui, 先從 npm 安裝
npm install unisoft-ui -S
在 mian.js 中引入
import UniSoftUI from 'unisoft-ui' Vue.use(UniSoftUI)
在組件中使用:
<template> <div id="app"> <h1>{{msg}}</h1> <uni-switch v-model="isSwitch"> <span class="text">{{switchText}}</span> </uni-switch> </div> </template> <script> export default { name: 'app', data() { return { msg: 'welecom to unisoft-ui', isSwitch: false, } }, computed: { switchText() { return this.isSwitch ? '開' : '關(guān)'; } }, } </script>
注意: 在發(fā)布npm包之前要先修改 .gitignore 去掉忽略 dist, 因?yàn)槲覀兇虬奈募残枰峤唬幻看紊系?npm 上需要更改版本號,package.json 里的 version 字段
總結(jié)
以上所述是小編給大家介紹的Vue 組件封裝 并使用 NPM 發(fā)布的教程,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持!
相關(guān)文章
vue3通過canvas實(shí)現(xiàn)圖片圈選功能
這篇文章將給大家詳細(xì)介紹了vue3如何通過canvas實(shí)現(xiàn)圖片圈選功能,文中的示例代碼講解詳細(xì),具有一定的參考價值,感興趣的小伙伴快來跟隨小編一起學(xué)習(xí)一下吧2023-12-12Vue監(jiān)聽數(shù)據(jù)渲染DOM完以后執(zhí)行某個函數(shù)詳解
今天小編就為大家分享一篇Vue監(jiān)聽數(shù)據(jù)渲染DOM完以后執(zhí)行某個函數(shù)詳解,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-09-09Vue.js實(shí)現(xiàn)開發(fā)購物車功能的方法詳解
這篇文章主要介紹了Vue.js實(shí)現(xiàn)開發(fā)購物車功能的方法,結(jié)合實(shí)例形式分析了基于vue.js開發(fā)的購物車功能相關(guān)操作步驟與實(shí)現(xiàn)技巧,需要的朋友可以參考下2019-02-02關(guān)于ElementUI自定義Table支持render
這篇文章主要介紹了關(guān)于ElementUI自定義Table支持render,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-10-10this.$router.push攜帶參數(shù)跳轉(zhuǎn)頁面的實(shí)現(xiàn)代碼
這篇文章主要介紹了this.$router.push攜帶參數(shù)跳轉(zhuǎn)頁面,this.$router.push進(jìn)行頁面跳轉(zhuǎn)時,攜帶參數(shù)有params和query兩種方式,本文結(jié)合實(shí)例代碼給大家詳細(xì)講解,需要的朋友可以參考下2023-04-04解決Vue2.0中使用less給元素添加背景圖片出現(xiàn)的問題
今天小編就為大家分享一篇解決Vue2.0中使用less給元素添加背景圖片出現(xiàn)的問題,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-09-09