基于vue-cli自定义ui组件库上传到npm

1.使用Vue-cli搭建项目

npm install  -g @vue/cli
vue create vue-demo
cd vue-demo
npm run serve

2.创建存放组件的文件夹
比如在src目录下创建了my-unicorn-ui文件夹,也有人习惯将这个文件夹放在src同级目录


image.png

3.在my-unicorn-ui目录下创建packpages文件夹,用来存放组件文件
比如封装了一个Button组件


image.png

注意: 自己封装的组件里面一定要有name属性,作为在其他项目中install这个组件库后,在页面中使用的具体组件名,类似elementUI库中的<el-button>、<el-form>


image.png

Button/Button.vue
<template>
  <div>
    <el-button>{{ msg }}</el-button>
    <!-- <div>{{ msg }}</div> -->
  </div>
</template>

<script>
export default {
  name: "UnButton", // 注意: 自己封装的组件里面一定要有name属性,为后期install node包后 在页面使用的组件名
  props: {
    msg: String,
  },
};
</script>

<style scoped>
</style>

Button/index.js
需要将组件导出并提供install方法

import UnButton from './button.vue'

UnButton.install = function (Vue) {
    Vue.component(UnButton.name, UnButton)
}
export default UnButton

4.在packages文件夹创建index.js,用于统一导出所有组件
packages/index.js

/**
 * 统一导出组件
 */
import Button from './Button'
// import Input from './Input'

// 组件集合用于遍历
const components = [Button]

// 定义install方法
const install = function (Vue) {
    if (install.installed) return
    // 遍历注册全局组件
    components.map(component => Vue.component(component.name, component))
}

// 判断是否存在全局的Vue对象,是的话代表是CDN方式使用,那么自动进行注册
if (typeof window !== "undefined" && window.Vue) {
    install(window.Vue)
}

export default {
    version: '1.0.0',
    install,
    Button
}

以上代码就是将封装好的组件注册为全局组件,用到了Vue.component()方法,当使用Vue.use()时,install方法便会执行
5.在项目的package.json文件中,配置打包命令

"package": "vue-cli-service build --target lib ./src/my-unicorn-ui/packages/index.js --name my-unicorn-ui --dest ./src/my-unicorn-ui/lib"
image.png

打包命令解释:
--target lib 关键字 指定打包的目录
--name 打包后的文件名字
--dest 打包后的文件夹的名称
6.执行打包命令
去到my-unicorn-ui目录下,执行打包命令

npm run package

打包执行完成后项目my-unicorn-ui目录下就会多出一个lib文件夹,存放的是打包后的文件


image.png

7.执行以下命令,在my-unicorn-ui文件夹下初始化一个package.json文件, 注意和项目的package.json不是同一个文件!

cd my-unicorn-ui
npm init -y

my-unicorn-ui/package.json

{
  "name": "my-unicorn-ui",
  "version": "1.0.0",
  "description": "npm install my-unicorn-ui --save",
  "main": "lib/my-unicorn-ui.common.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

8.新增 README.md文档,方便其他用户使用

# my-unicorn-ui

## 安装
npm install my-unicorn-ui --save

## 引入
import myUnicornUi from '@test/my-unicorn-ui'
<!-- import '@test/my-unicorn-ui/my-unicorn-ui.css' -->

## 全局注册
Vue.use(myUnicornUi)

## 页面使用
<UnButton msg="999"/>

9.发布到npm仓库
9.1注册账号
想要发布到npm仓库,先要有一个账号,去npm官网注册一个账号,注意记住用户名、密码和邮箱,发布的时候会用到。

9.2设置npm镜像源
有些可能本地的npm镜像源采用的是淘宝镜像源或者其它的,如果想要发布npm包,先把npm源切换为官方得源,命令如下

npm config set registry=https://registry.npmjs.org

9.3添加npm用户
进入my-unicorn-ui目录,添加npm用户,执行命令

npm adduser

填写用户名、密码、邮箱,然后会收到一封邮件,邮件里面有个类似于验证码的东西,如果之前设置过即可跳过此步。

9.4发布npm
在my-unicorn-ui目录下执行命令

npm publish
image.png

10.从npm安装使用

npm install my-unicorn-ui --save

main.js中引用注册

import MyUnicornUI from 'my-unicorn-ui'
Vue.use(MyUnicornUI)

页面使用
在项目的某页面中使用即可,注意使用的标签名是上面开发的组件的name,以下两种写法均可

<UnButton msg="888"/>
<un-button msg="888"/>

11.组件未发布npm可在本地引入测试

<template>
  <div id="app">
    <UnButton msg="88888" />
  </div>
</template>

<script>
import UnButton from "./my-unicorn-ui/packages/Button/index";

export default {
  name: "App",
  components: {
    UnButton,
  },
};
</script>

<style>
</style>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,468评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,620评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,427评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,160评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,197评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,334评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,775评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,444评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,628评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,459评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,508评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,210评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,767评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,850评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,076评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,627评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,196评论 2 341

推荐阅读更多精彩内容