在npm组件库上发布npm组件

本文档详细介绍了如何从初始化项目到创建Vue组件库,包括组件编写、暴露、配置package.json以及打包发布的全过程。关键步骤包括在packages目录下创建组件,通过index.js导出组件,修改package.json配置,并通过npm进行打包和发布。最后,说明了如何在其他项目中安装和使用这些开源组件。
摘要由CSDN通过智能技术生成

一、初始化项目

打开cmd窗口,执行vue create 项目名称。

二、组件项目目录

初始化完成之后,我们需要创建一个packages目录,存放开源的组件,如果有需求需要展示的文档界面,那么我们可以把src目录改成example。在vue.config.js同级目录创建一个index.js文件,index.js是把packages目录下的组件文件暴露出去的出口。

三、组件库关键代码

1.编写组件

首先我们在packages下创建相对于组件的文件夹,然后创建index.vue文件,编写组件,如果有公共的样式的话,在项目一级目录下创建一个styles目录文件夹,在index.vue引入需要的样式文件。

2. 将组件作为vue插件

在tables目录下创建一个index.js文件,将tables组件作为vue插件。

3.将每个组件暴露出来

在项目的一级目录index.js中将每个组件的index.js文件通过import引入进来,然后通过install.installed检查组件库是否安装到node_modules中,再将全局组件遍历注册(这是重点,如果不注册,怎么把组件暴露出去?),最后通过export把install方法导出,不然怎么能被调用的时候通过Vue.use()方法安装。

 

4.修改package.json文件的配置

name:组件名称

Version:版本号(每发布一次版本,都需要修改版本号,不能重复)

main:指定该npm包引用的入口(文件名应与打包生成的文件名保持一致)

files:指定需要打包的文件夹

description:组件名称

keywords:组件引用的第三方开源组件

lib: (vue-cli-service build --target lib --name tables --dest lib index.js)指定打包的入口

 

四、npm打包发布

1. npm login 注册并登陆npm账号

2.npm run lib 打包

3. Npm publish 发布组件到npm上

注意点:

邮箱必须要先注册

包名不能有大写字母/空格/下划线,不能和npm上已经开源库的名称重复

五、开源库使用

1. 安装依赖

npm i tables

2. 在main.js引入

 在页面中直接调用组件就可以了


 

 

 

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值