当前位置:Gxlcms > JavaScript > 第一个Vue插件从封装到发布

第一个Vue插件从封装到发布

时间:2021-07-01 10:21:17 帮助过:17人阅读

前言

这是我封装的第一个Vue插件,实现的功能是滑动选择省市区,虽然只是一个简单的插件,但还是挺开心的,记录一下步骤。

  插件地址:https://github.com/leichangchun/vue-area-select     欢迎指正

准备

  Vue官网插件部分的介绍虽然很简单,但是还是好好刷一遍的。由于此插件较为简单,主要用到以下两个点:

  1 . Vue的插件需要有一个公开方法install

  2 . 通过全局方法 Vue.use() 使用插件,在下文有栗子

创建工程

  初始化工程

  1. vue init webpack-simple projectName
  2. cd projectName
  3. cnpm install //安装依赖

  创建开发组件目录如下

开发插件

  插件入口index.js需要引入插件组件,写install方法

  1. import vueAreaSelect from './components/vue-area-select' //引入组件
  2. const areaSelect = {
  3. install (Vue, options) {
  4. Vue.component(vueAreaSelect.name, vueAreaSelect) //全局组件
  5. }
  6. }
  7. export default areaSelect //导出

  vue-area-select.vue是插件的具体实现部分,就不过多介绍,详见源码。

  调试时的引用方式是引入index.js文件

  1. //引入
  2. import areaSelect from './index.js'
  3. Vue.use(areaSelect)
  4. //.vue中 使用
  5. <vue-area-select></vue-area-select>

  调试完成后,需要build,然后再npm发布。build的时候需要先修改webpack.config.js中的配置,然后 npm run build 打包文件

  1. // entry: './src/main.js', //npm run dev时 demo调试的入口
  2. entry: './src/index.js', //打包时 插件入口
  3. output: {
  4. path: path.resolve(__dirname, './dist'),
  5. publicPath: '/dist/',
  6. // filename: 'build.js'
  7. filename: 'vue-area-select-lei.js', //打包生成文件的名字
  8. library:'AreaSelect', //reqire引入的名字
  9. libraryTarget:'umd',
  10. umdNamedDefine:true
  11. }

  此时,插件开发部分已经完成。之后就需要npm发布。

NPM发布

  先配置package.json,需要加入以下几项

  1. "private": false,
  2. "main": "dist/vue-area-select-lei.js", //import引入时默认寻找的文件
  3. "repository": { //仓库地址
  4. "type": "git",
  5. "url": "https://github.com/leichangchun/vue-area-select"
  6. },

  然后npm login 登录账号   npm publish发布插件

  插件的方式使用

  1. npm install vue-area-select-lei --save //安装
  2. //插件的方式引入使用
  3. import areaSelect from 'vue-area-select-lei'
  4. Vue.use(areaSelect)

 效果如下:

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

人气教程排行