vue组件如何被其他项目引用

2024-01-10 17:00:58

自己写的vue组件怎么才能让其他人引用呢，或者是共用组件如何让其他项目引用。本文就粗细的介绍下，如有疑问欢迎共同讨论。在这里你能了解下如下知识点：

1. 如何发布一个包到npmjs仓库上

2.如何引用一个npm包，尤其是本地引用

3.vue组件的两种引用方案

一、发布一个包到npm的步骤

在npmjs.org上注册一个账号
然后进入命令提示窗口输入：
1. npm adduser: 进入添加用户
2. Username your name: 设置用户名
3. Password your password: 设置密码
4. Email youremail：设置邮箱

登录信息都保存在用户目录下的.npmrc文件中（以token的方式保存）

npm publish：发布包

执行npm publish这前，请切换到需要发包的项目根目录下。

npm unpublish --force：移除一个发布包（也可以移除指定版本的包）
注意：
- 发包前必须要在npmjs上注册一个账号
- 每次发布的时候都需要重新更新版本
- 也可以用npm logout登出用户，用npm login登录用户

二、build方式引用vue组件

示例使用的是本地安装一个npm包。因为把包发布到npmjs，然后再npm到项目中太过麻烦（由于我们要做来回调整和测试）。实现vue组件三步骤：

1. 配置组件（被引用的组件），可以省略

配置package.json，主要是增加main节点

"main": "index.js"

主是main的这个节点，如果不配置，我们在其他项目中就不用import XX from '包名'来引用了，只能以包名作为起点来指定相对的路径。

导出可供外部访问的组件

import VueTree from './components/Hello'
module.exports = {
    VueTree
}

主要是导出可以让外部访问的组件，这里没有直接导出main.js，是因为我们所需要的是一些子组件，而根组件（因为他存在直接挂载到dom上的操作）。

编写打包成为一个组件的脚本

var webpack = require('webpack')
var path = require('path')
var vueLoaderConfig = require('./vue-loader.conf')

function resolve (dir) {
  return path.join(__dirname, '..', dir)
}

var opt = {
  entry: {
    'vue-tree-common': './src/comp.js'
  },
  output: {
    path: resolve('dist'),
    filename: '[name].js',
    library: 'vue-tree-common',
    libraryTarget: 'commonjs2' //注意这里，打包的标准
  },
  resolve: {
    extensions: ['.js', '.vue'],
    modules: [
      resolve('src'),
      resolve('node_modules')
    ]
  },
  module: {
    rules: [
      {
        test: /\.vue$/,
        loader: 'vue-loader',
        options: vueLoaderConfig
      },
      {
        test: /\.js$/,
        loader: 'babel-loader',
        include: [resolve('src'), resolve('node_modules')]
      }
    ]
  }
}

var compiler = webpack(opt)
compiler.run(function(err, state) {
  console.log(err)
})

此种打包方式会将此组件的所有引用打包成一个文件，还是存在不合理的现象。

生成包通过上述三个步骤的配置，只需要运行打包成组件的脚本就可以生成发布包了。

2、本地如何引用npm包（安装发布好的包）

用命令模式进入开发项目文件夹，用命令安装包。npm install --save 本地路径即可。

npm install --save D:\MyProject\vue2-tree

3、根据包名直接定位组件

<template>
  <div id="app">
    <img src="./assets/logo.png">
    <hello></hello>
    <VueTree></VueTree>
  </div>
</template>

<script>
import Hello from './components/Hello'
import {VueTree} from 'vue-tree/dist/vue-tree-common' //重点

export default {
  name: 'app',
  components: {
    Hello,  
    VueTree
  }
}
</script>

<style>
#app {
  font-family: 'Avenir', Helvetica, Arial, sans-serif;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  text-align: center;
  color: #2c3e50;
  margin-top: 60px;
}
</style>

此处我用的是import {VueTree} from 'vue-tree/dist/vue-tree-common这种方式引入的包，因为在原到用的package.json中main节点配置的index.js。

三、更为直接的引用vue组件

我们还需要npm本地安装或者再现安装；
按照如下图所示引用：

四、总结

vue的版本需要一致，如果不一致需要调整。
vue的几种打包方式：UMD、common、esm。
vue分为部分和完成打包，区别就是template的支持。
vue组件样式存在图片的引用时，请使用单独的样式引入，因为组件的引入是不带图片的。
“build方式引用vue组件”此方式可以把组件打成不同的包，方便不同规范引用。

转自:https://www.cnblogs.com/armyfai/p/14131461.html

码农公寓