vue自定义封装组件,并发布到npm上 (完整说明)_vue3+vite 封装组件并发布npm-程序员宅基地

技术标签: vue组件库封装  vue  自定义vue组件  npm  vue.js  sass  javascript  

1. 案例自定义组件结构 (自己创建项目目录)

vue-plugin —
           |— build // 构建配置
                |— webpack.base.conf.js  // 基础构建配置
                |— webpack.prod.conf.js  // 打包(正式环境)的构建配置
                ...
           |— config // 运行环境配置
           |— packages  // 组件内容
                |— menu  // 具体的组件
                   |— menu.vue 
                   |— index.js  // 该组件的组测脚本
                |— config  // 组件内容配置信息
           |— utils  // 组件的工具类
           |— css  // 组件引入的样式
               |— variable.scss  // 样式变量
               |— mixin.scss  // 样式混合
               |— menu.scss  // menu组件样式
               |— index.scss  样式总集
           |— src
              |— ...
              |— index.js  // 自定义组件的打包脚本(组件库的入口)
              |— main.js  // 项目的本地运行和构建项目脚本
           |— package.json 
           |— README.md

 2. 自定义新建一个项目  (这里利用vue-cli2.0, 好修改配置信息)

vue init vue-plugin
// 然后安装依赖并运行

npm install

npm run dev


3. 创建组件 以及每个组件的注册脚本(组件入口)

// 创建menu组件
menu.vue

// 创建一个注册脚本 (和组件平级)
// index.js
import Menu from './menu'

Menu.install = Vue => Vue.component(Menu.name, Menu)
export default Menu

4.创建一个组件库入口(脚本)
 

// index.js (在src下方,与main.js平级)
import Menu from '../packages/menu/index';

const components = [Menu]

const install = function(Vue. opts={}) {
    components.forEach(component => {
      Vue.component(component.name, component)
    })
}

if (typeof window !== 'undefined' && window.Vue) {
    install(window.Vue)
}

export default {
    install,
    Menu
}
// 若是依赖第三方UI库, 则需要将其引入 以element-ui为例, 需要在以上的代码中添加如下代码
import Vue from 'vue'
import ELement from 'element-ui'

Vue.use(Element)
import 'element-ui/lib/theme-chalk/index.css'

 5. 修改webpack.base.conf.js
  

export default {
        entry: process.env.NODE_ENV === 'production' ? './src/index.js' : './src/main.js',
        output: {
            path: config.build.assetsRoot,
            filename: 'index.min.js',
            publicPath: process.env.NODE_ENV === 'production'
              ? config.build.assetsPublicPath
              : config.dev.assetsPublicPath,
            library: 'Application', // 指定的就是你使用require时的模块名
            libraryTarget: 'umd',  // 指定输出格式
            umdNamedDefine: true // 会对 UMD 的构建过程中的 AMD 模块进行命名。否则就使用匿名的 define
        }
    }
    
    
    library:指定的就是你使用require时的模块名
  libraryTarget:为了支持多种使用场景,我们需要选择合适的打包格式。常见的打包格式有 CMD、AMD、UMD,CMD只能在 Node 环境执行,AMD 只能在浏览器端执行,UMD 同时支持两种执行环境。显而易见,我们应该选择 UMD 格式。

  有时我们想开发一个库,如lodash,underscore这些工具库,这些库既可以用commonjs和amd方式使用也可以用script方式引入。

  这时候我们需要借助library和libraryTarget,我们只需要用ES6来编写代码,编译成通用的UMD就交给webpack了

  umdNamedDefine:会对 UMD 的构建过程中的 AMD 模块进行命名。否则就使用匿名的 define

6. 修改 webpack.prod.conf.js
 

// 这里主要修改 plugins中间的配置 主要就保留以下两个插件即可
plugins: {
    // 关于js的压缩插件
    new UglifyJsPlugin({
      uglifyOptions: {
        compress: {
          warnings: false
        }
      },
      sourceMap: false,
      parallel: true
    }),
    // 关于css的压缩
    new ExtractTextPlugin({
      filename: 'index.min.css'
    }),
}

 7. 修改package.json 文件

{
    "name": "@styleofpicasso/vue-plugin",  // 插件名称
    "version": "0.0.1", // 插件版本
    "author": "styleofpicasso",
    "main": "dist/index.min.js",  // 打包后的文件入口
    "files": [  // npm 发布的文件包含哪些
      "dist",
      ...
    ],
    "private": false,  // 公开项目,因为组件包是公用的,所以private要改为false
    "keywords": [ // 关键词,可以通过npm搜索你填写的关键词找到你的模块
       "vue",
       "components"
       ...
    ],
    "homepage": "https://xx.github.io/xx/xx-btn/dist/index.html", // 项目官网的url
    "bugs": { // 填写一个bug提交地址或者一个邮箱,被你的模块坑到的人可以通过这里吐槽
        "url": "https://github.com/xx/xx-btn/issues"
    },
    "repository": { // 指定代码所在的仓库地址
        "type": "git",
        "url": "https://github.com/xx/xx-btn.git"
    },
}

8. 样式的编译 (主题色编译 —— 支持用户自定义)

  • variable.scss
$--color: orange !default;  // 这里加上 !default, 是默认色,当用户在项目中自定义了 $--color, 会优先使用用户自定义的

$--static-color: #333 !default;
...
  • mixin.scss

 

  • menu.scss  [当然。这里的样式,我们在menu.vue中在写一次,同时用到变量需要将变量scss文件 引入]
// 具体样式
.menu {
    color: $--color;
}
  • index.scss
     
@import './variable';

@import './menu';
....


9. 编译打包 / 测试插件 

// 编译打包
npm run build

// 测试插件
npm pack
// npm pack 之后,会在当前目录下生成以一个 styleofpicasso-vue-plugin-0.0.1.tgz 文件

// 打开vue项目,并将该文件放在项目的根目录下,并运行以下命令 (这里的路径时绝对路径)
npm install 路径/styleofpicasso-vue-plugin-0.0.1.tgz

// 安装成功之后,直接在项目中使用该插件,看是否能用,
import VuePlugin from '@styleofpicasso/vue-plugin',
Vue.use(VuePluin)

// 若是能用就直接发布到npm官网,再在项目中重新安装npm插件  (这里需要注意要将package.json中关于插件的包安装地址进行清除,否则会一直安装测试包)

10. 发布 npm包


具体操作,这里就不加说明了,大家都知道

11. 安装使用

  •  安装
npm install @styleofpicasso/vue-plugin --save
或
yarn add @styleofpicasso/vue-plugin
  • 使用
import VuePlugin from '@styleofpicasso/vue-plugin'
Vue.Use(VuePlugin)

// 这里是直接包内的样式及主题
// import '@styleofpicasso/3d-application/dist/index.min.css';

// 自定义主题色 (创建一个自己的文件 shared.scss, 包含内容如下)
$--color: 色值  // 按钮鼠标移入色值
$--static-color: 色值 // 默认色值
@import '@styleofpicasso/3d-application/src/plugin/package/css/index.scss';

//在入口文件引入
import '../../css/shared.scss'

 

这里需要注意: 若是基于element-ui开发的组件,  选择直接使用插件的固定主
需要将element-ui中关于字体的fonts文件夹复制到static文件下,保证引入的样式中不报错
 

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/zhumany_csdn/article/details/114688364

智能推荐

Spring Boot 获取 bean 的 3 种方式!还有谁不会?,Java面试官_springboot2.7获取bean-程序员宅基地

文章浏览阅读1.2k次,点赞35次,收藏18次。AutowiredPostConstruct 注释用于在依赖关系注入完成之后需要执行的方法上,以执行任何初始化。此方法必须在将类放入服务之前调用。支持依赖关系注入的所有类都必须支持此注释。即使类没有请求注入任何资源,用 PostConstruct 注释的方法也必须被调用。只有一个方法可以用此注释进行注释。_springboot2.7获取bean

Logistic Regression Java程序_logisticregression java-程序员宅基地

文章浏览阅读2.1k次。理论介绍 节点定义package logistic;public class Instance { public int label; public double[] x; public Instance(){} public Instance(int label,double[] x){ this.label = label; th_logisticregression java

linux文件误删除该如何恢复?,2024年最新Linux运维开发知识点-程序员宅基地

文章浏览阅读981次,点赞21次,收藏18次。本书是获得了很多读者好评的Linux经典畅销书**《Linux从入门到精通》的第2版**。下面我们来进行文件的恢复,执行下文中的lsof命令,在其返回结果中我们可以看到test-recovery.txt (deleted)被删除了,但是其存在一个进程tail使用它,tail进程的进程编号是1535。我们看到文件名为3的文件,就是我们刚刚“误删除”的文件,所以我们使用下面的cp命令把它恢复回去。命令进入该进程的文件目录下,1535是tail进程的进程id,这个文件目录里包含了若干该进程正在打开使用的文件。

流媒体协议之RTMP详解-程序员宅基地

文章浏览阅读10w+次,点赞12次,收藏72次。RTMP(Real Time Messaging Protocol)实时消息传输协议是Adobe公司提出得一种媒体流传输协议,其提供了一个双向得通道消息服务,意图在通信端之间传递带有时间信息得视频、音频和数据消息流,其通过对不同类型得消息分配不同得优先级,进而在网传能力限制下确定各种消息得传输次序。_rtmp

微型计算机2017年12月下,2017年12月计算机一级MSOffice考试习题(二)-程序员宅基地

文章浏览阅读64次。2017年12月的计算机等级考试将要来临!出国留学网为考生们整理了2017年12月计算机一级MSOffice考试习题,希望能帮到大家,想了解更多计算机等级考试消息,请关注我们,我们会第一时间更新。2017年12月计算机一级MSOffice考试习题(二)一、单选题1). 计算机最主要的工作特点是( )。A.存储程序与自动控制B.高速度与高精度C.可靠性与可用性D.有记忆能力正确答案:A答案解析:计算...

20210415web渗透学习之Mysqludf提权(二)(胃肠炎住院期间转)_the provided input file '/usr/share/metasploit-fra-程序员宅基地

文章浏览阅读356次。在学MYSQL的时候刚刚好看到了这个提权,很久之前用过别人现成的,但是一直时间没去细想, 这次就自己复现学习下。 0x00 UDF 什么是UDF? UDF (user defined function),即用户自定义函数。是通过添加新函数,对MySQL的功能进行扩充,就像使..._the provided input file '/usr/share/metasploit-framework/data/exploits/mysql

随便推点

webService详细-程序员宅基地

文章浏览阅读3.1w次,点赞71次,收藏485次。webService一 WebService概述1.1 WebService是什么WebService是一种跨编程语言和跨操作系统平台的远程调用技术。Web service是一个平台独立的,低耦合的,自包含的、基于可编程的web的应用程序,可使用开放的XML(标准通用标记语言下的一个子集)标准...

Retrofit(2.0)入门小错误 -- Could not locate ResponseBody xxx Tried: * retrofit.BuiltInConverters_已添加addconverterfactory 但是 could not locate respons-程序员宅基地

文章浏览阅读1w次。前言照例给出官网:Retrofit官网其实大家学习的时候,完全可以按照官网Introduction,自己写一个例子来运行。但是百密一疏,官网可能忘记添加了一句非常重要的话,导致你可能出现如下错误:Could not locate ResponseBody converter错误信息:Caused by: java.lang.IllegalArgumentException: Could not l_已添加addconverterfactory 但是 could not locate responsebody converter

一套键鼠控制Windows+Linux——Synergy在Windows10和Ubuntu18.04共控的实践_linux 18.04 synergy-程序员宅基地

文章浏览阅读1k次。一套键鼠控制Windows+Linux——Synergy在Windows10和Ubuntu18.04共控的实践Synergy简介准备工作(重要)Windows服务端配置Ubuntu客户端配置配置开机启动Synergy简介Synergy能够通过IP地址实现一套键鼠对多系统、多终端进行控制,免去了对不同终端操作时频繁切换键鼠的麻烦,可跨平台使用,拥有Linux、MacOS、Windows多个版本。Synergy应用分服务端和客户端,服务端即主控端,Synergy会共享连接服务端的键鼠给客户端终端使用。本文_linux 18.04 synergy

nacos集成seata1.4.0注意事项_seata1.4.0 +nacos 集成-程序员宅基地

文章浏览阅读374次。写demo的时候遇到了很多问题,记录一下。安装nacos1.4.0配置mysql数据库,新建nacos_config数据库,并根据初始化脚本新建表,使配置从数据库读取,可单机模式启动也可以集群模式启动,启动时 ./start.sh -m standaloneapplication.properties 主要是db部分配置## Copyright 1999-2018 Alibaba Group Holding Ltd.## Licensed under the Apache License,_seata1.4.0 +nacos 集成

iperf3常用_iperf客户端指定ip地址-程序员宅基地

文章浏览阅读833次。iperf使用方法详解 iperf3是一款带宽测试工具,它支持调节各种参数,比如通信协议,数据包个数,发送持续时间,测试完会报告网络带宽,丢包率和其他参数。 安装 sudo apt-get install iperf3 iPerf3常用的参数: -c :指定客户端模式。例如:iperf3 -c 192.168.1.100。这将使用客户端模式连接到IP地址为192.16..._iperf客户端指定ip地址

浮点性(float)转化为字符串类型 自定义实现和深入探讨C++内部实现方法_c++浮点数 转 字符串 精度损失最小-程序员宅基地

文章浏览阅读7.4k次。 写这个函数目的不是为了和C/C++库中的函数在性能和安全性上一比高低,只是为了给那些喜欢探讨函数内部实现的网友,提供一种从浮点性到字符串转换的一种途径。 浮点数是有精度限制的,所以即使我们在使用C/C++中的sprintf或者cout 限制,当然这个精度限制是可以修改的。比方在C++中,我们可以cout.precision(10),不过这样设置的整个输出字符长度为10,而不是特定的小数点后1_c++浮点数 转 字符串 精度损失最小

推荐文章

热门文章

相关标签