vue3+ts+vite自定义组件上传npm流程

  1. 创建组件库项目:



# 使用vite创建一个新项目
npm init vite@latest my-vue-component-library -- --template vue-ts
 
# 进入项目目录
cd my-vue-component-library
 
# 安装依赖
npm install
  1. 编写组件:

    src目录下创建你的组件文件,例如MyButton.vue




<template>
  <button :class="`my-button-size-${size}`">{{ label }}</button>
</template>
 
<script lang="ts">
import { defineComponent } from 'vue';
 
export default defineComponent({
  name: 'MyButton',
  props: {
    label: String,
    size: {
      type: String,
      default: 'medium'
    }
  }
});
</script>
 
<style scoped>
.my-button-size-small {
  /* 小按钮样式 */
}
.my-button-size-medium {
  /* 中等按钮样式 */
}
.my-button-size-large {
  /* 大按钮样式 */
}
</style>
  1. 配置库的入口文件:

    src目录下创建index.ts文件,作为库的入口。




// src/index.ts
export { default as MyButton } from './MyButton.vue';
  1. 配置vite.config.ts



// vite.config.ts
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
 
// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue()],
  build: {
    lib: {
      entry: './src/index.ts',
      name: 'MyVueComponentLibrary',
      fileName: (format) => `my-vue-component-library.${format}.js`,
    },
    rollupOptions: {
      // 确保外部化处理依赖
      external: ['vue'],
      output: {
        globals: {
          vue: 'Vue'
        }
      }
    }
  }
});
  1. 添加package.json配置:



{
  "name": "my-vue-component-library",
  "version": "1.0.0",
  "description": "My Vue 3 Component Library",
  "main": "dist/my-vue-component-library.umd.js",
  "module": "dist/my-vue-component-library.esm.js",
  "unpkg": "dist/my-vue-component-library.global.js",
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "vite build"
  },
  "peerDependencies": {
    "vue": "^3.0.0"
  },
  "publishConfig": {
    "access": "public"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/username/my-vue-component-library.git"
  },
  "author": "Your Name",
  "license": "MIT",
  "keywords": ["vue", "components", "library"],
  "homepage": "https://github.com/username/my-vue-component-library#readme"
}
  1. 发布到NPM:

    确保你有一个NPM账号,登录后发布:




npm publish
  1. 使用组件库:



npm install my-vue-component-library

然后在你的Vue项目中使用:




<script setup lang="ts">
import { MyButton
VUE , npm
最后修改于:2024年08月15日 13:54

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日