# 封装成UI组件库

# 目录调整

  • 根目录创建两个文件夹packagesexamples
packages: 用于存放所有的组件
examples: 用于进行测试, 把src改成examples
1
2
  • 把components中所有的组件放入到package中
  • 把fonts放在package中
  • 删除原来的src目录

# vue.config.js配置

新增vue.config.js配置

const path = require('path')
module.exports = {
  pages: {
    index: {
      entry: 'examples/main.js',
      template:'public/index.html',
      filename:'index.html'
    }
  },
  // 扩展 webpack 配置, 使 packages 加入编译
  chainWebpack: config => {
    config.module 
      .rule('js')
      .include.add(path.resolve(__dirname,'packages')).end()
      .use('babel')
      .loader('babel-loader')
      .tap(options => {
        // 修改它的选项...
        return options
      })
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
  • 统一导出packages中所有的组件
// 整个包的入口
// 导入颜色选择器
import Button from './button.vue'
import Dialog from './dialog.vue'
import Input from './input.vue'
import Checkbox from './checkbox.vue'
import CheckboxGroup from './checkbox-group.vue'
import Radio from './radio.vue'
import RadioGroup from './radio-group.vue'
import Switch from './switch.vue'
import Form from './form.vue'
import FormItem from './form-item.vue'
import './fonts/font.scss'

// 存储组件列表
const components = [
  Button,
  Dialog,
  Input,
  Checkbox,
  CheckboxGroup,
  Radio,
  RadioGroup,
  Switch,
  Form,
  FormItem
]

// 定义 install 方法, 接收 Vue 作为参数. 如果使用 use 注册插件, 则所有的组件都会被注册
const install = function(Vue) {
  // 遍历注册全局组件
  components.forEach(component => {
    Vue.component(component.name, component)
  })
   
}

// 判断是否是直接引入文件, 如果是, 就不用调用 Vue.use()
if(typeof window !== 'undefined' && window.Vue) {
  install(window.Vue)
}

export default install
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

# 测试

在examples中的main.js中进行导入测试

import Vue from 'vue'
import App from './App.vue'
import router from './router'
import XcoooUI from '../packages'

Vue.config.productionTip = false
Vue.use(XcoooUI)

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

1
2
3
4
5
6
7
8
9
10
11
12
13

Appvue

<template>
  <div id="app">
    <xc-button type="primary">星城哈哈</xc-button>
  </div>
</template>
1
2
3
4
5

效果

xcooo

# 发布到npm与github

# 发布到github

# 发布到npm

  • 在scripts中新增一条 打包命令
    "lib": "vue-cli-service build --target lib packages/index.js"
1

启动 yarn lib 打包为一个库

yarn lib
1
  • 发布到npm

修改package.json文件

  "private": false,
  "main": "dist/xcooo-ui.umd.min.js",
  "author": {
    "name": "星城哈哈"
  },
1
2
3
4
5

增加 .npmignore文件

# 忽略目录
examples/
packages/
public/

# 忽略指定文件
vue.config.js
babel.config.js
*.map
1
2
3
4
5
6
7
8
9

最后上传到npm

首先列出可供选择的源

nrm ls
1

如果之前是淘宝源, 必须手动切换到 npm源, 才可以

nrm use npm
1
xcooo

然后 进行登录, 输入你的账号密码以及邮箱

npm login
1

最后进行发布

npm publish
1

如果后续增加组件,上传到npm, 需要再次使用 yarn lib进行打包, 并修改版本号

xcooo
上次更新: 2020/11/24 上午10:39:25