本文共 2563 字,大约阅读时间需要 8 分钟。
写在前面
小小的前端有大大的梦想。做一个属于我们自己的 UI 组件库应该是个不错的小目标了。那。。。组件是什么?我想应该不用多说,在日常开发中我们天天与之打交道,你所写的每一个 vue 文件都可以当做是一个组件,只不过通用性有所区别而已。组件写得多了,随着时间的推移,你就会有写一个组件库的冲动了。
造轮子其实就是在梳理知识
知识前置
我们可能习惯了在一个 vue 里面引入组件的方式,所以先这里要巩固一下全局引入组件的方式。举个栗子,一般我们的用法是这样的:
上面两种方式都可以用来全局注册组件,但是参数不一样,选择哪种方法都可以,但要留意一下第二种方法,这种方法需要组件本身有个 install 的方法。额。。。为啥要有 install 的方法?这个你就当做是规定就好,你用人家的框架就得遵循人家的规则。扯犊子吧,其实是因为执行 Vue.use 的时候会执行里面的 install 方法,所以我们需要写个 install。对此你不用较真,寄人篱下是这样的,哦不对♀️,应该是站在大神的肩膀上。
搭建目录
这步应该不用多说吧,执行一下 vue create xr-ui(前提是你安装了 vue-cli3),然后看自己喜好选择一些配置,几下回车之后一个清爽的初始项目就有了。这里我没有选择用 typescript(主要是我还没习惯用它),所以选用 typescript 的同学们注意啦,可能写法会有少许不同,有劳大伙看着改下吧。
修改目录结构
你可能会问为什么要建这样的目录结构,问得好,原因很简单,因为别人是这样做的,所以借鉴(模仿)。。。我们可以看到 Element 的源码也是这样的结构
添加配置文件
小改了一下目录之后,你会惊奇的发现项目运行不了了。没关系,这很正常,毕竟 src 都不见了,路径啥的肯定得报错。所以现在我们来解决这个问题。 在根目录下新建一个 vue.config.js 文件(新项目是没有这个文件的),并写入以下内容:
上面的注释应该都写的挺明了,主要就是修改别名、修改入口文件以及把新文件加入 webpack 编译这几个步骤。然后我们再运行一下程序就可以跑得通了。至于为什么这么配置、或者怎么配置,不了解的同学可以去 Vue Cli 官网看下,上面写的是清清楚楚、明明白白,然而我也只是懂那么一两个配置而已,还没学会 webpack 的套路,因为常常是用的时候看一眼,一阵子不用就又忘了,没办法♀️脑子不行。
编写组件
一个组件库没有组件怎么行呢,所以我们要先写个 test 组件(你可以随便写,这不重要)。ok,我们先在 packages 目录下新建一个 test 文件夹,再在 test 文件夹下下面新建一个 src 文件夹,在 src 文件夹下面新建一个 test.vue 组件,大概长下面这样子:
应该都能看懂吧,不过多解释。⚠️这里主要强调一点,就是 name 这个名字尤为重要,我就在这个坑里呆了挺久。首先它是必须要写的,为啥呢,你可以把它理解为 id,具有唯一标识组件的作用,将来我们可是要通过这个 name 来找到和判定这是什么组件,所以你写的所有组件应该是不重名的;其次这个 name 就是我们最终的标签名,比如这里我们的 name 是 XrTest,到时候我们写的标签就长这样 ,就像 Element 一样,name 是 ElButton,用的时候就是 。
暴露组件
让我们在 packages/test 下面新建一个 index.js 文件,具体代码如下:
这步的精髓就在于给组件扩展一个 install 方法,至于为什么要扩展这个方法,文章开头已经说到了,是因为 Vue.use() 的需要,use 会默认调用 install 方法安装,仅此而已。接着我们在 packages 下面也新建一个 index.js 文件,注意和上面那个 index.js 区别开,上面那个是针对单个组件安装的,这个是针对所有组件全局安装的,先看代码:
这步的主要作用就是统一导出所有组件及暴露 install 方法。之前的 index.js 只是安装单个组件,而现在这个 index.js 是循环安装所有组件,具体使用就看你是不是要按需引用了。这里给个目录结构方便大家观看:
因为这步挺重要的,所以建议好好停下来理解消化一下。。。
当然你可能会问道,为什么这样建目录?一目了然,就是一种代码风格
组件测试
ok,组件写完了,接下来我们就在 examples 下面测试一下,看看能不能引用成功。 首先在 examples 下的 main.js 中引入刚刚写好的包,就像下面这样:
然后把 examples/views 下面的 Home.vue 里面的内容删了,写入自己标签组件,就像下面这样:
好了,最后让我们运行一下项目 yarn serve,看看效果,嗯,还凑合吧。
库模式打包
在 vue-cli3 中我们通过以下命令可以将一个单独的入口打包成一个库:
// target: 默认为构建应用,改为 lib 即可启用构建库模式// name: 输出文件名// dest: 输出目录,默认为 dist,这里我们改为 lib// entry: 入口文件路径vue-cli-service build --target lib --name lib [entry]复制代码
要注意的是在库模式中,打包出来的库中是不包含 Vue 的。 然后我们修改一下 package.json 文件,就像下面这样:
接着执行 npm run lib 就能生成库啦,看看左侧的目录是不是多了个 lib 文件夹,那个就是我们要发布的东西。
补充下,lib 目录下面的 js 之所以有好几种,是因为有两种规范(common 和 umd)、是否压缩(min)和映射(map)的区别,暂且知道有这么回事就行,不用深究。
发布到npm
万事俱备,只欠发布。
{ "name": "xr-ui
转载地址:http://doxys.baihongyu.com/