vue元件，可以通過npm引用的元件

小龍女先生發表於2017-03-02
Vue元件NPM

本文章通過實現一個vue-dialog的彈出層元件，然後附加說明如果釋出此包到npm，且能被其他專案使用。

功能說明

  • 多層彈出時，只有一個背景層。
  • 彈出層嵌入內部元件。
  • 彈出層按鈕支援回撥
  • 原始碼下載

實現

  • 多層彈出時，只有一個背景層
    利用兩個元件實現，一個背景層元件（只提供一個背景層，元件名：background.vue），一個彈出層內容管理元件（實現多個內容層的管理，元件名：master.vue)。
  • 彈出層嵌入內部元件
    使用vue的component元件實現，他可以完美支援。
  • 彈出層按鈕支援回撥
    在master.vue中實現，詳細解析此程式碼
    html程式碼
<template>
    <div> 
        <div class="modal-content"  v-for="(comp,index) in comps" v-bind:style="style(index,comp)" >
          <div class="modal-header" >
            header
          </div>
          <div class="modal-body">
            <component :is="comp"></component>
          </div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" v-on:click="clickHandler(btn.value, comp, index)" v-for="btn in btns" >{{btn.text}}</button>
          </div>
        </div> 
      <hDialogBack ref="back" v-bind:z-index="realIndex-1" ></hDialogBack>
    </div>
</template>
  • comps：內部元件的集合
  • realIndex：一個computed屬性，讀取props的mIndex屬性，表示內部層的zIndex層級關係。
  • component載入元件
  • btns：表示按鈕的集合，現還不支援元件獨立配置按鈕列表。
  • style：此方法用於生成內部元件居中的css程式碼。

js程式碼:

<script>
import hDialogBack from './background'

function getclientPoint () {
  return {
    width: document.documentElement.clientWidth || document.body.clientWidth,
    height: document.documentElement.clientHeight || document.body.clientHeight
  }
}

export default {
  name: 'HDialog',
  data () {
    return {
      comps: []
    }
  },
  props: {
    'btns': {
      type: Array,
      default: function () {
        return [{ text: 'ok', value: 'ok'}, { text: 'cancel', value: 'cancel'}]
      }
    },
    'mIndex': {
      type: Number,
      default: 19861016
    }
  },
  computed: {
    realIndex: function () {
      return this.mIndex
    }
  },
  components: {
    hDialogBack
  },
  methods: {
    open: function (comp) {
      comp.promise = new Promise(function (resolve, reject) {
        comp.resolve = resolve
        comp.reject = reject
      })
      comp.width = comp.width || 600
      comp.height = comp.height || 400
      this.comps.push(comp)
      if (!this.$refs.back.show) {
        this.$refs.back.open()
      }
      return comp.promise
    },
    clickHandler: function (type, comp, index) {
      let self = this
      let close = function () {
        self.comps.splice(index, 1)
        if (self.comps.length === 0 && self.$refs.back.show) {
          self.$refs.back.close()
        }
      }
      /** 只提供promise模式 */
      comp.resolve({'type': type, 'close': close})
    },
    style: function (index, comp) {
      let point = getclientPoint()
      return {
        zIndex: this.realIndex + index,
        width: comp.width + 'px',
        height: comp.height + 'px',
        left: ((point.width - comp.width) / 2) + 'px',
        top: ((point.height - comp.height) / 2) + 'px'
      }
    }
  }
}
</script>
  • open方法，用於開啟彈出層，且返回一個Promise。
  • 嵌入background.vue元件，用於提供背景層。
  • clickHandler方法：master.vue元件按鈕的事件響應函式，會resolve在open方法中提供的promise。

css程式碼：

<style>
.modal-content {
  position: absolute;
}
</style>

如何實用

  • 首先需要在頂層引入master.vue，然後嵌入到與app元件平級，如下程式碼：
new Vue({
  el: '#app',
  template: '<div><App></App><HDialog ref="hDialog" ></HDialog></div>',
  components: { App }
})

一定要指定ref值，這是彈出層實現的關鍵。

  • 在任意一個子元件中如下使用：
let promise = this.$root.$refs.hDialog.open({
      template: '<div>第二層了</div>'
    })
    promise.then(function (arg) {
      alert('第二層' + arg.type)
      arg.close()
})
  • 使用$root.$refs找到彈出層管理元件
  • 使用呼叫其open方法，並接受一個promise型別的返回值
  • 使用promise即可。

釋出到npm

  • 如果元件需要被其他人引用，最好使用commonjs2規範，webapck如下配置:
output: {
path: './dist',
filename: '[name].js',
library: 'vue-hdialog',
libraryTarget: 'commonjs2'
}
  • 在npmjs上註冊一個賬號
  • 利用npm login 登入
  • 使用npm publish 釋出，如果你想解除安裝可以用npm unpublish --force.
  • 釋出是需要package.json檢測version和name欄位，如果已存，或者是存在被解除安裝的都不行。
  • package.json中的main節點是指定其他引用時，預設匯出的檔案。

相關文章