vue 插件开发教程与发布

原创 2018年04月16日 00:04:13

前言

对于插件的好处就不用多说了~~~~

看了vue官方的vue插件开发的文档,讲的比较粗略,看完一头雾水的,所以决定自己研究开发了一个组件,并写成一个教程。

就拿基于vue的一个toast组件开始吧

项目初始化

封装vue的插件用webpack-simple很合适,vue init webpack-simple project-name此命令创建我们的项目的目录,创建文件夹和文件,最后结构是这样的


lib目录是我们的插件目录,其他的默认就好

toast.vue的内容如下:

<template>
<div class="vue-toast-wraper" v-show="isSHowToast" style="display:none">
{{toastMsg}}
</div>
</template>
<script>
export default {
name:'toast',
props:{
toastMsg:{
default:"",
type:String
},
isSHowToast:{
default:false,
type:Boolean
}
},
mounted(){
if(this.isSHowToast){
setTimeout(() => {
this.isSHowToast=false
},2500);
}
}
}
</script>
<style scoped>
.vue-toast-wraper{
background: rgba(0, 0, 0, 0.6);
color: #fff;
font-size: 17px;
padding: 10px;
border-radius:12px;
display: -webkit-box;
-webkit-box-pack: center;
-webkit-box-align: center;
position: fixed;
top: 50%;
left: 50%;
z-index: 2000;
-webkit-transform: translateY(-50%);
transform: translateY(-50%);
-webkit-transform: translateX(-50%);
transform: translateX(-50%);
}
</style>



toast.js中写install方法,内容如下:

import VueToastPlugin from './toast.vue'
const toastPlugin = {
install: function(Vue) {
Vue.component(VueToastPlugin.name, VueToastPlugin)
}
}
// global 情况下 自动安装
if (typeof window !== 'undefined' && window.Vue) {
window.Vue.use(toastPlugin)
}
// 导出模块
export default toastPlugin


我们在webpack配置的入口文件就是toast.js,install是挂载组件的方法,有了它我们就可以在外部use一个插件了。 

接下来就是修改配置文件,为打包发布做准备

修改配置项

修改package.json

{
"name": "vue-toast-plugin-catbea",
"description": "A Vue.js project",
"version": "1.0.1",
"author": "catbea<xxxxx@qq.com>",
"main": "dist/toast.js",
"license": "MIT",
"private": false,
"scripts": {
"dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
"build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
},
"dependencies": {
"vue": "^2.5.11"
},
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
],
"keywords": [
"vue",
"toast"
],
"repository": {
"type": "git",
"url": "git+https://github.com/linmoer/catbea/vue-toast.git"
},
"homepage": "https://github.com/catbea/vue-toast/new/master?readme=1",
"devDependencies": {
"babel-core": "^6.26.0",
"babel-loader": "^7.1.2",
"babel-preset-env": "^1.6.0",
"babel-preset-stage-3": "^6.24.1",
"cross-env": "^5.0.5",
"css-loader": "^0.28.7",
"file-loader": "^1.1.4",
"vue-loader": "^13.0.5",
"vue-template-compiler": "^2.4.4",
"webpack": "^3.6.0",
"webpack-dev-server": "^2.9.1"
}
}

修改webpack.config.js

var path = require('path')
var webpack = require('webpack')

module.exports = {
// entry: './src/main.js',
entry: './src/lib/toast.js',
output: {
path: path.resolve(__dirname, './dist'),
publicPath: '/dist/',
filename: 'toast.js',
library: 'vueToast',
libraryTarget: 'umd',
umdNamedDefine: true
},
module: {
rules: [
{
test: /\.css$/,
use: [
'vue-style-loader',
'css-loader'
],
}, {
test: /\.vue$/,
loader: 'vue-loader',
options: {
loaders: {
}
// other vue-loader options go here
}
},
{
test: /\.js$/,
loader: 'babel-loader',
exclude: /node_modules/
},
{
test: /\.(png|jpg|gif|svg)$/,
loader: 'file-loader',
options: {
name: '[name].[ext]?[hash]'
}
}
]
},
resolve: {
alias: {
'vue$': 'vue/dist/vue.esm.js'
},
extensions: ['*', '.js', '.vue', '.json']
},
devServer: {
historyApiFallback: true,
noInfo: true,
overlay: true
},
performance: {
hints: false
},
devtool: '#eval-source-map'
}

if (process.env.NODE_ENV === 'production') {
module.exports.devtool = '#source-map'
// http://vue-loader.vuejs.org/en/workflow/production.html
module.exports.plugins = (module.exports.plugins || []).concat([
new webpack.DefinePlugin({
'process.env': {
NODE_ENV: '"production"'
}
}),
new webpack.optimize.UglifyJsPlugin({
sourceMap: true,
compress: {
warnings: false
}
}),
new webpack.LoaderOptionsPlugin({
minimize: true
})
])
}


修改.gitignore 文件

因为要用dist文件夹,所以在.gitignore文件中把dist/去掉。

修改index.html

打包项目

npm run build 

发布到NPM

  1. npm官网 注册一个npm账号
  2. 切换到需要发包的项目根目录下,npm adduser 输入npm账号,输入用户名、密码、邮箱
  3. 最后一步,执行npm publish即可

发布到NPM后,使用插件时可以用npm install 组件名称 来安装

这里我封装了一个toast组件toast,可以在查看 https://github.com/catbea/vue-toast  查看

觉得可以,小哥哥小姐姐给一个小star呀——

有任何疑问可在下方留言!!!



版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/dq674362263/article/details/79955197

jQuery实用插件

-
  • 1970年01月01日 08:00

Vue.js插件开发入门

相对 组件 来说,Vue 的 插件 开发受到的关注要 少 一点。但是插件的功能是十分强大的,能够完成许多 Vue 框架本身不具备的功能。 大家一般习惯直接调用现成的插件,比如官方推荐的 vue-rou...
  • NotBad_
  • NotBad_
  • 2017-01-08 23:30:14
  • 3621

vue plugin 插件编写以loading为例

我们在使用vue开发的过程中,经常会遇到这两个问题: 我要使用loading(加载动画) toast(浮层提示) dialog(弹框提示)之类的全局性组件,但是用全局组件注册的话非常麻烦,还要在tem...
  • sjn0503
  • sjn0503
  • 2017-07-16 17:21:50
  • 4841

为 Vue 编写一个插件

1 介绍 以编写Vue日志插件为例,讲述从插件的开发到部署。 原文  https://lluvio.github.io/blog/plugin-for-vuejs.html ...
  • sinat_17775997
  • sinat_17775997
  • 2017-05-15 02:53:25
  • 1537

vue.js 初体验— Chrome 插件开发实录

通过一个Chrome插件的开发,来领略下vue.js的魅力。顺便也来了解下Chrome插件开发的一些基本知识。在日常工作中,开发一些小工具可以大大的提高我们的工作效率。...
  • QcloudCommunity
  • QcloudCommunity
  • 2017-05-12 10:06:03
  • 3296

自己写个vue.js插件(1):自定义指令的妙用

写个插件文档:https://vuefe.cn/guide/plugins.html1.在components 目录下新建一个validate.js:export default{ insta...
  • github_26672553
  • github_26672553
  • 2016-11-05 18:43:35
  • 18060

vue环境搭建

1)需要安装node.js,这里我们就不具体说了,下载后,一直下一步就可以了。 【附node.js安装:】 http://www.runoob.com/nodejs/nodejs-instal...
  • sinat_32546159
  • sinat_32546159
  • 2017-09-11 22:21:19
  • 1187

<em>Vue</em>.js 前端<em>开发</em> 快速入门与专业应用 高清完整版PDF

基础特性、指令、过滤器、过渡、组件、状态管理、常用<em>插件</em>、工程实例和Weex打包。...<em>vue</em>js<em>教程</em>中文 高清完整.pdf版 立即下载 上传者: qq_34193388 时间: 2016-09...
  • 2018年04月16日 00:00

自己动手开发Vue插件(之一)Vue插件之公共方法封装

Vue插件之公共方法封装 官方教程: MyPlugin.install = function (Vue, options) { // 1. 添加全局方法或属性 ...
  • github_38847071
  • github_38847071
  • 2018-03-22 10:38:19
  • 109

vue自定义全局组件(自定义插件)

vue自定义组件(自定义插件)能够提高你的代码的重用率,并且写一个有自己特色的组件。...
  • Tank_in_the_street
  • Tank_in_the_street
  • 2017-06-12 19:20:15
  • 8775
收藏助手
不良信息举报
您举报文章:vue 插件开发教程与发布
举报原因:
原因补充:

(最多只允许输入30个字)