vue lib 模式构建自己的组件库

为什么构建组件库

不用再重复造轮子,所有的项目都能用;希望有一套一类应用的标准,并且对组件的样式有较高的要求,那么你就需要开发一个组件库了

开发组件库步骤
1.创建项目:正常的创建vue项目
2.修改配置:

在scripts字段中新增一个命令脚本,如:

"build-lib": "vue-cli-service build  --target lib --entry src/components/index.js --name uiLib";

--target属性表示构建目标,默认为应用模式,这里需要设置为lib,表示启用库模式。
--name属性表示构建的名称,可以与package.json文件中的name字段的值不相同;
--最后表示入口文件,默认为src/App.vue,在这里我们修改为了./src/index.js。

"scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint",
    "build-lib": "vue-cli-service build  --target lib --entry src/components/index.js --name uiLib"
  },
3.编写组件,导出组件

正常的编写一个组件,例如在componets文件下创建一个myButton文件,建一个MyButton组件,(可以多创建几个UI组件,例如再创建一个MyInput 组件)。


image.png

在src下创建index.js,编写导出组件的代码

import MyInput from './my-input'
import MyButton from './my-button';

// 存储组件列表
const components = [
    MyInput,
    MyButton
]
//install是让业务代码在main.js 引入之后 use(myUi)  注册到全局用的
const install = (app, opts = {}) => {
    components.forEach(item => {
        app.component(item.name, item)
    })
}

const exportObject = {
    // 全局导出
    version: '1.0.0',
    install
};
export default exportObject;
4.打包组件库

根目录下打开cmd窗口,输入npm run build-lib命令
在根目录下会生成dist文件夹,其里面的文件如下图所示:

image

到此,组件已经完成构建了。将打包好的****.umd.min.js直接放到业务项目中,直接引入也是可以用的。

5.将组件发布到npm的步骤

首先是注册npm:

1.官网注册
https://www.npmjs.com/signup
2.命令行注册
npm adduser //按照提示输入用户名,邮箱等即可
3.注册后登陆
npm login //按照提示输入用户名,密码,邮箱等即可

在业务项目中安装

npm install --save @username/component-name //@npm官网注册username/组件项目名 == @username/component-name

然后引入
import '@username/component-name'

使用即可

6.优化

1.排外打包
如果组件库项目和业务项目引用了相同的依赖,比如element,可以设置排外打包,在业务项目中引用即可,减少组件库包体积。

image.png

2.按需引入
在组件库项目改动如下:
例如,在myButton下建一个js文件,编写单独导出组件的代码,如图:


image.png

在src目录下的index.js文件,将componets/MyButton.vue组件导出:



import MyInput from './my-input'
import MyButton from './my-button';

// 存储组件列表
const components = [
    MyInput,
    MyButton
]

const install = (app, opts = {}) => {
    components.forEach(item => {
        app.component(item.name, item)
    })
}

const exportObject = {
    // 全局导出
    version: '1.0.0',
    install,
    MyInput, // 单独导出button组件用于按需加载
    MyButton
};

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

推荐阅读更多精彩内容