如何实现一个公共组件库上传到npm并在项目中使用

简介: 如何实现一个公共组件库上传到npm并在项目中使用

目录


一般多个项目使用一些公共组件的时候,我们没必要在每个项目里写公共组件代码,我们可以将公共组件封装成一个库,上传至npm,这样我们在项目中使用就可以直接从npm下载直接使用。当然我们也可以搭建自己本地的npm镜,而本文主要讲述上传npm。


创建一个新的vue项目


vue create catui

在src目录下新建package文件放置我们所写的公共组件


写一个button的公共组件


在package下新建bin-button文件,index.js文件,并在bin-button文件下新建index.vue

目录:/catui/src/package/bin-button/index.vue

<template>
    <button @click="handleClick" :disabled='disabled'>
        <slot></slot>
    </button>
</template>
<script>
export default {
    name: "BinButton",
    props: {
        disabled: Boolean
    },
    methods: {
        handleClick(evt) {
            this.$emit('click', evt);
        }
    }
};
</script>

目录:/catui/src/package/index.js

出口文件:引入封装好的组件进行批量注册,然后导出。

// 引入封装好的组件
import BinButton from "../package/bin-button/index.vue"; /
// 将来如果有其它组件,都可以写到这个数组里
const coms = [BinButton]; 
// 批量组件注册
const install = function (Vue) {
  coms.forEach((com) => {
    Vue.component(com.name, com);
  });
};
export default install; // 这个方法以后再使用的时候可以被use调用

为什么导出为install?

安装 Vue.js 插件。如果插件是一个对象,必须提供 install 方法。如果插件是一个函数,它会被作为install 方法。install 方法调用时,会将 Vue 作为参数传入。

package.json

作为一个组件库,我们必须按照npm的发包规则来编写我们的package.json, 我们先来解决组件库打包的问题,首先我们需要让脚手架编译我们的组件代码,并输出到指定目录下,我们按照发包规范一般会输出到lib目录下,代码如下:


组件库上传npm需要按照npm规则来编写package.json。

{
  "name": "catui",  //包名
  "version": "0.1.1", //版本号
  "description": "", //介绍
  "author": "cat", //作者
  "main": "caui/xui.umd.min.js", //入口js
  "license": "ISC", //许可证
  "scripts": {
    "serve": "vue-cli-service serve",
    "lint": "vue-cli-service lint",
    "build": "vue-cli-service build --target lib ./src/package/index.js --name cat-ui --dest cat-ui",
  },
}

其中

  • target lib: 启动文件的路径
  • name:打包后生成的文件名
  • dest: 打包后生成的文件夹名


打包项目


打包后的目录如下:


上传npm


首先注册npm账号,后登录

npm login
//输入账号、密码、邮箱

升级版本(按需求)

 "version": "0.1.4" <=> [major].[minor]. patch 
 对应的版本为大版本|中版本|小版本
npm version patch  (升级小版本号)
npm version minor(升级中版本号)
npm version major (升级大版本号)

发布到npm

npm publish

如果有报错

npm publish --access public

查看镜像源,如果之前有修改过npm的源需要重新设置

npm get registry
//设置镜像源(如果不是下面的源,则需要执行下面的命令) 
npm config set registry=https://registry.npmjs.org

【特别提醒】:确保本地源服务是 registry.npmjs.org,国内大家都喜欢使用taobao镜像源,但是发布不能发到该服务器上。本人使用 nrm 工具进行镜像源的管理和切换。

可以直接在npm官网搜索到

安装并使用


安装


yarn add catui
yarn add catui


在main,js中引入


import catui from "catui"
vue.use(catui)

app.vue中使用

<bin-button disabled></bin-button>
<bin-button></bin-button>

下图可以看出我们设置disabled属性生效了

目录
相关文章
|
6月前
项目打包报错“caniuse-lite is outdated. Please run next command `npm update`”的解决方案
项目打包报错“caniuse-lite is outdated. Please run next command `npm update`”的解决方案
275 1
|
1月前
|
JavaScript 安全 测试技术
vue封装组件发布到Npm
【10月更文挑战第17天】
|
1月前
|
移动开发 小程序 数据可视化
基于npm CLI脚手架的uniapp项目创建、运行与打包全攻略(微信小程序、H5、APP全覆盖)
基于npm CLI脚手架的uniapp项目创建、运行与打包全攻略(微信小程序、H5、APP全覆盖)
236 3
|
30天前
|
缓存 前端开发 JavaScript
前端架构思考:代码复用带来的隐形耦合,可能让大模型造轮子是更好的选择-从 CDN 依赖包被删导致个站打不开到数年前因11 行代码导致上千项目崩溃谈谈npm黑洞 - 统计下你的项目有多少个依赖吧!
最近,我的个人网站因免费CDN上的Vue.js包路径变更导致无法访问,引发了我对前端依赖管理的深刻反思。文章探讨了NPM依赖陷阱、开源库所有权与维护压力、NPM生态问题,并提出减少不必要的依赖、重视模块设计等建议,以提升前端项目的稳定性和可控性。通过“left_pad”事件及个人经历,强调了依赖管理的重要性和让大模型代替人造轮子的潜在收益
|
1月前
|
前端开发 JavaScript 开发工具
从零开始:构建、打包并上传个人前端组件库至私有npm仓库的完整指南
从零开始:构建、打包并上传个人前端组件库至私有npm仓库的完整指南
258 0
|
2月前
|
JavaScript
使用npm,快速构建第一个vue项目
本文介绍了如何使用npm快速构建第一个Vue项目。步骤包括确保安装了Node.js并且配置了正确的环境变量,创建一个空文件夹并使用VSCode打开,通过VSCode的终端执行`npm init vue@latest`命令以初始化项目,选择默认配置即可。接着安装项目依赖并启动开发服务器,最后通过浏览器访问开发服务器提供的本地地址查看项目运行结果。文章还提供了相关代码和操作截图。
|
2月前
|
缓存 JavaScript 前端开发
8种方法解决vue创建项目报错:command failed: npm install --loglevel error
该文章提供了八种解决Vue项目创建时遇到的`command failed: npm install --loglevel error`错误的方法,包括清理缓存、更换npm源、重新安装Node.js等措施。
8种方法解决vue创建项目报错:command failed: npm install --loglevel error
|
3月前
|
资源调度 JavaScript API
Vue3+TS+Vite开发组件库并发布到npm
这篇文章介绍了如何使用Vue 3、TypeScript和Vite开发一个包含35个常用UI组件和8个API功能函数的组件库`vue-amazing-ui`,并将其发布到npm,同时提供了组件库的安装使用说明和在线预览。
103 2
Vue3+TS+Vite开发组件库并发布到npm
|
3月前
|
缓存 资源调度 JavaScript
Vue3+TS+Vite开发组件库并发布到npm
**vue-amazing-ui 组件库** 是一个基于 Vue 3 的高质量 UI 组件库,提供了丰富的组件和工具函数。该库已发布至 npm,可通过 `pnpm i vue-amazing-ui`、`yarn add vue-amazing-ui` 或 `npm install vue-amazing-ui` 安装使用。组件包括按钮、面包屑、卡片、日期选择器等,同时提供了日期格式化、节流、防抖等实用工具函数。项目结构清晰,支持按需加载,并提供了详细的文档与在线预览。
117 1
Vue3+TS+Vite开发组件库并发布到npm
|
5月前
npm构建vite项目
npm构建vite项目