一婚温、基于vue的國家區(qū)號列表
vue-flag-list包含了大部分國家的區(qū)號,點擊右邊的三角形展開列表可以選擇國家區(qū)號媳否,若列表中沒有區(qū)號栅螟,也可以自己輸入?yún)^(qū)號。
1.1 初始化組件
用的是vue-cli來初始化組件篱竭,雖然有很多東西不需要力图,因為對這個比較熟悉,所以還是按照這個步驟來室抽。
vue init webpack vue-flag-list
cd vue-flag-list
cnpm install
npm run dev
1.2 根據(jù)自己的需求搪哪,實現(xiàn)具體功能,我的主要功能寫在vue-flag-list.vue組件中坪圾。
<template>
<div id="flag">
...
</div>
</template>
<script>
export default {
name: 'vue-flag-list',
...
}
</script>
<style scoped>
...
</style>
功能寫好后晓折,修改package.json等配置文件,為打包發(fā)布做準備
1.3 添加index.js
import flagComponent from './Vue-Flag-List.vue'
const VueFlagList = {
install: function (Vue) {
if (typeof window !== 'undefined' && window.Vue) {
Vue = window.Vue
}
Vue.component('VueFlagList', flagComponent)
}
}
export default VueFlagList
1.4 修改配置文件
1.4.1 package.json
{
"name": "vue-flag-list",
"version": "1.0.0",
"description": "A vue plugin for entering and selecting area code",
"author": "guimin",
// 因為組件包是公用的兽泄,所以private為false
"private": false,
// 配置main結點漓概,如果不配置,我們在其他項目中就不用import XX from '包名'來引用了病梢,只能以包名作為起點來指定相對的路徑
"main": "dist/vue-flag-list.min.js",
"scripts": {
"dev": "node build/dev-server.js",
"start": "node build/dev-server.js",
"build": "node build/build.js"
},
// 指定代碼所在的倉庫地址
"repository": {
"type": "git",
"url": "git+https://github.com/linmoer/vue-flag-list.git"
},
// 指定打包之后胃珍,包中存在的文件夾
"files": [
"dist",
"src"
],
// 指定關鍵字
"keywords": [
"vue",
"flag",
"code",
"flag code"
],
"license": "MIT", //開源協(xié)議
// 項目官網(wǎng)的url
"homepage": "https://github.com/linmoer/vue-flag-list#readme",
"dependencies": {
"vue": "^2.3.3"
},
"devDependencies": {
...
},
"engines": {...},
"browserslist": [...]
}
1.4.2 .gitignore 文件
因為要用dist文件夾梁肿,所以在.gitignore文件中把dist/去掉。
1.4.3 webpack.prod.conf.js 文件
為了支持多種使用場景觅彰,我們需要選擇合適的打包格式吩蔑。常見的打包格式有 CMD、AMD填抬、UMD烛芬,CMD只能在 Node 環(huán)境執(zhí)行,AMD 只能在瀏覽器端執(zhí)行飒责,UMD 同時支持兩種執(zhí)行環(huán)境赘娄。顯而易見,我們應該選擇 UMD 格式宏蛉。Webpack 中指定輸出格式的設置項為 output.libraryTarget遣臼,其支持的格式有:
- “var” - 以一個變量形式輸出: var Library = xxx (default);
- “this” - 以 this 的一個屬性輸出: this[“Library”] = xxx拾并;
- “commonjs” - 以 exports 的一個屬性輸出:exports[“Library”] = xxx揍堰;
- “commonjs2” - 以 module.exports 形式輸出:module.exports = xxx;
- “amd” - 以 AMD 格式輸出辟灰;
- “umd” - 同時以 AMD个榕、CommonJS2 和全局屬性形式輸出。
以下是 webpack.prod.conf.js 中 output 設置的示例:
output: {
path: path.resolve(__dirname, '../dist'),
publicPath: '',
filename: 'vue-flag-list.min.js',
library: 'VueFlagList',
libraryTarget: 'umd',
umdNamedDefine: true
},
Vue 是組件庫的外部依賴芥喇。組件庫的使用者會自行導入 Vue西采,打包的時候,不應該將 Vue 打包進組件庫继控。但是械馆,如果你將打包后的組件庫以 <script> 標簽形式直接引入,你會發(fā)現(xiàn)并不能正常執(zhí)行武通,提示 vue 未定義霹崎。
以 <script> 標簽形式使用組件時,會同樣使用 <script> 標簽導入 Vue冶忱。Vue 導入的變量是 “window.Vue” 而不是 “window.vue”尾菇,因此會出現(xiàn) vue 未定義的錯誤。
所以囚枪,我們需要在 webpack.prod.conf.js 中配置 externals派诬,如下:
externals: {
vue: {
root: 'Vue',
commonjs: 'vue',
commonjs2: 'vue',
amd: 'vue'
}
},
另外,為了將css打包成一個文件链沼,所以需要將 webpack.prod.conf.js 中的
plugins 選項的
new ExtractTextPlugin({
filename: utils.assetsPath('css/[name].[contenthash].css')
}),
修改為
new ExtractTextPlugin({
filename: 'vue-flag-list.min.css'
}),
修改入口文件
entry: {
app: './src/index.js'
},
1.5 整理一下目錄結構默赂,我的目錄結構如下:
- vue-flag-list
+ build
+ dist
- src
+ img
index.js
Vue-Flag-List.vue
...
二、用npm發(fā)布一個包
- 在發(fā)正式包之前可以在本地先打一個包括勺,然后測試下有沒有問題缆八,如果沒問題再發(fā)布到npm上曲掰。
2.1 打包到本地使用
npm run build
npm pack
npm pack 之后,就會在當前目錄下生成 vue-flag-list-1.0.0.tgz 的文件奈辰。
打開一個新的vue項目栏妖,在當前路徑下執(zhí)行('路徑' 表示文件所在的位置)
cnpm install 路徑/vue-flag-list-1.0.0.tgz
在新項目的入口文件(main.js)中引入
import VueFlagList from 'vue-flag-list'
import 'vue-flag-list/dist/vue-flag-list.min.css'
Vue.use(VueFlagList)
在組件中使用
<flagCode height="30" width="120" @getCode="getCode"></flagCode>
methos: {
getCode(code) {
console.log(code)
}
}
2.2 發(fā)布到npm
1、在 npm官網(wǎng) 注冊一個npm賬號
2冯挎、切換到需要發(fā)包的項目根目錄下底哥,登錄npm賬號咙鞍,輸入用戶名房官、密碼、郵箱
npm login
3续滋、最后一步翰守,執(zhí)行npm publish即可
# lin@lin-Pro in ~/www/vue-flag-list on git:master $ npm publish
# lin@lin-Pro in ~/www/vue-flag-list on git:master $ + vue-flag-list@1.0.0
三、后記
折騰了很久疲酌,終于把vue-flag-list插件的雛形發(fā)布出去了蜡峰,這是一個很簡單的插件,以后會繼續(xù)維護它朗恳,添加更多的實用功能湿颅。
- git地址:https://github.com/LRithe/vue-flag-list
- npm unpublish --force:移除一個發(fā)布包(也可以移除指定版本的包)
- npm logout:登出用戶