Vue 组件封装 并使用 NPM 发布的教程
正文开始
vue 开发插件
我们可以先查看vue的插件的开发规范
我们开发的之后期望的结果是支持 import、require 或者直接使用 script 标签的形式引入,就像这样:
ps: 这里注意一下包的名字前缀是 unisoft ,组件的名字前缀是 uni
import unisoftui from 'unisoft-ui'; // 或者 const customui = require('unisoft-ui'); // 或者 <script src="..."></script> vue.use(unisoftui);
回到顶部
构建一个 vue 项目
开发组件我们使用 webpack-simple 模板:
vue init webpack-simple <project-name>
ps: 这里我选择了 use sass 因为之后开发组件会用到
目录结构如图:
├── src/ // 源码目录
│ ├── packages/ // 组件目录
│ │ ├── switch/ // 组件(以switch为例)
│ │ ├── uni-switch.vue // 组件代码
│ │ ├── index.js // 挂载插件
│ ├── app.vue // 页面入口
│ ├── main.js // 程序入口
│ ├── index.js // (所有)插件入口
├── index.html // 入口html文件
开发单个组件:
先看一下目标效果:
开始开发:
在 packages 文件夹下新建一个 switch 文件夹用来存放 switch 组件的源码,继续在 switch 文件夹中新建 uni-switch.vue 和 index.js 文件
uni-switch.vue 组件:
<template> <div class="uni-switch"> <div class="wrapper"> <span><slot></slot></span> <div :class="[{closed: !checked}, 'switch-box']" @click="handlechange(value)"> <span :class="{closed: !checked}"></span> </div> <input type="checkbox" @change="handlechange" :true-value="activevalue" :false-value="inactivevalue" :disabled="disabled" :value="value"/> </div> </div> </template> <script> export default { name: "uniswitch", data() { return {} }, props: { value: { type: [boolean, string, number], default: false }, activevalue: { type: [boolean, string, number], default: true }, inactivevalue: { type: [boolean, string, number], default: false }, disabled: { type: boolean, default: false } }, computed: { checked() { return this.value === this.activevalue; } }, methods: { handlechange(value) { this.$emit('input', !this.checked ? this.activevalue : this.inactivevalue); } } } </script>
index.js:
// uniswitch 是对应组件的名字,要记得在 moor-switch.vue 文件中还是 name 属性哦 import uniswitch from './uniswitch.vue'; uniswitch.install = vue => vue.component(uniswitch.name, uniswitch); export default uniswitch;
好了基本完成了,但是为了将所有的组件集中起来比如我还有 select、 input、 button 等组件,那么我想要统一将他们放在一个文件这中便于管理
所以在 app.vue 同级目录我新建了一个 index.js 文件
import uniswitch from './packages/switch/index'; import unislider from './packages/slider/index'; import uninumbergrow from './packages/number-grow/index'; import './common/scss/reset.css' // ...如果还有的话继续添加 const components = [ uniswitch, unislider, uninumbergrow // ...如果还有的话继续添加 ] const install = function (vue, opts = {}) { components.map(component => { vue.component(component.name, component); }) } /* 支持使用标签的方式引入 */ if (typeof window !== 'undefined' && window.vue) { install(window.vue); } export default { install, uniswitch, unislider, uninumbergrow // ...如果还有的话继续添加 }
好了到这里我们的组件就开发完成了;下面开始说怎么打包发布到 npm 上
发布到 npm
打包之前,首先我们需要改一下 webpack.config.js 这个文件;
// ... 此处省略代码 const node_env = process.env.node_env module.exports = { // 根据不同的执行环境配置不同的入口 entry: node_env == 'development' ? './src/main.js' : './src/index.js', output: { // 修改打包出口,在最外级目录打包出一个 index.js 文件,我们 import 默认会指向这个文件 path: path.resolve(__dirname, './dist'), publicpath: '/dist/', filename: 'custom-ui.js', library: 'custom-ui', // 指定的就是你使用require时的模块名 librarytarget: 'umd', // librarytarget会生成不同umd的代码,可以只是commonjs标准的,也可以是指amd标准的,也可以只是通过script标签引入的 umdnameddefine: true // 会对 umd 的构建过程中的 amd 模块进行命名。否则就使用匿名的 define }, // ... 此处省略代码 }
然后, 再修改package.json 文件:
// 发布开源因此需要将这个字段改为 false "private": false, // 这个指 import custom-ui 的时候它会去检索的路径 "main": "dist/unisoft-ui.js",
发布命令只有两步骤:
npm login // 登陆
npm publish // 发布
完成之后我们就可以在项目中安装使用了
在项目中使用unisoft-ui
在自己的项目中使用unisoft-ui, 先从 npm 安装
npm install unisoft-ui -s
在 mian.js 中引入
import unisoftui from 'unisoft-ui' vue.use(unisoftui)
在组件中使用:
<template> <div id="app"> <h1>{{msg}}</h1> <uni-switch v-model="isswitch"> <span class="text">{{switchtext}}</span> </uni-switch> </div> </template> <script> export default { name: 'app', data() { return { msg: 'welecom to unisoft-ui', isswitch: false, } }, computed: { switchtext() { return this.isswitch ? '开' : '关'; } }, } </script>
注意: 在发布npm包之前要先修改 .gitignore 去掉忽略 dist, 因为我们打包的文件也需要提交;每次上到 npm 上需要更改版本号,package.json 里的 version 字段
总结
以上所述是小编给大家介绍的vue 组件封装 并使用 npm 发布的教程,希望对大家有所帮助
下一篇: 鸡肉卷怎么做,有什么功效