vue自訂指令實作v-tap插件

vue-touch基於hammer，對於普通簡單手勢的頁面來說太龐大！

於是想自己實現一個最常用的手勢tap。順著自訂指令和插件文檔，昨晚實作了一個v-tap指令，丟出這篇乾貨。

指令與插件介紹
自訂指令和插件官方文件中也介紹比較簡單詳細，就不過多介紹。
我先說下本插件就用了三個API，如果大家不了解最好先事先看下文檔避免後面的程式碼看的迷糊。

指令部分
1.update(nVal,oVal)
2.acceptStatement

插件部分
Vue.use()

接著我們需要像寫jQuery插件一樣學習寫入Vue
的格式。

繼續官方文件

MyPlugin.install = function (Vue, options) {
 // 1. 添加全局方法或属性
 Vue.myGlobalMethod = ...
 // 2. 添加全局资源
 Vue.directive('my-directive', {})
 // 3. 添加实例方法
 Vue.prototype.$myMethod = ...
}

   

是不是看的還不太懂？那我們可以直接看作者的插件程式碼。

;(function () {
 
 var vueTouch = {}
 
 vueTouch.install = function (Vue) {
 
 Vue.directive('touch', {
 
  isFn: true,
  acceptStatement: true,
 
  bind: function () {
 
  },
 
  update: function (fn) {
 
  },
 
  unbind: function () {
 
  }
 })
 }
 
 if (typeof exports == "object") {
 module.exports = vueTouch
 } else if (typeof define == "function" && define.amd) {
 define([], function(){ return vueTouch })
 } else if (window.Vue) {
 window.VueTouch = vueTouch
 Vue.use(vueTouch)
 }
 
})()

   

我把多餘無關程式碼都刪除了，可以發現其實格式就是如此，剩下的就是利用我們自己js的功底直接編寫即可。

PS：關於 isFn:true 這個屬性，我在文檔中沒有查到相關信息，個人認為可能是一種註釋,代表這個指令是需要fn的expression(這個是指令的表達式，詳見指令實例屬性) 。

Just do it

首先，依照插件格式先寫好外層。

;(function() {
 var vueTap = {};
 vueTap.install = function(Vue) {
 
 };
 
 if (typeof exports == "object") {
  module.exports = vueTap;
 } else if (typeof define == "function" && define.amd) {
  define([], function(){ return vueTap })
 } else if (window.Vue) {
  window.vueTap = vueTap;
  Vue.use(vueTap);
 }
 
})();

   

接著在我們的 vueTap.install 裡寫我們自己的自訂指令

Vue.directive('tap', {
  isFn : true,
  bind : function() {
 
  },
  update : function(fn) {
 
  },
  unbind : function() {},
  isTap : function() {
   //判断是否为tap
  },
  touchstart : function(e,self) {
 
  },
  touchend : function(e,self) {
 
  }
 });
};

   

處理過程都寫在update裡了。

PS: 當然也有小夥伴喜歡在這把fn都賦予在this(這裡的this是directve實例)上,最後在bind的地方綁定事件。這個我沒有找到規範，還不知道寫哪比較好。

update : function(fn) {
 var self = this; //存下this，方便以后用
  //在directive上绑定的属性和方法
  //都可通过self.xxx self.touchstart()获取
  self.tapObj = {}; //初始化我们的tap对象
 
 if(typeof fn !== 'function') {
 //你别给我搞事！
  return console.error('The param of directive "v-tap" must be a function!');
 }
 
 self.handler = function(e) { //给当前directive存个handler方便之后调用
  e.tapObj = self.tapObj;
  //把我们的tap对象赋值给原生event对象上，方便回调里获取参数
  fn.call(self,e);
 };
 
 //把我们的start和end剥离出来，写在directive上
 //由于只有tap事件，所以我们在move过程就不需要做处理
 this.el.addEventListener('touchstart',function(e) {
  self.touchstart(e,self);
 },false);
 
 this.el.addEventListener('touchend',function(e) {
  self.touchend(e,self,fn);
 },false);
 
}

   

在update很簡單，就是一些初始化，事件綁定和給實例賦值的過程。
最後就是isTap，touchstart，touchend的邏輯處理。

isTap : function() {
 var tapObj = this.tapObj;
 return this.time < 150 && Math.abs(tapObj.distanceX) < 2 && Math.abs(tapObj.distanceY) < 2;
},
touchstart : function(e,self) {
 var touches = e.touches[0];
 var tapObj = self.tapObj;
 tapObj.pageX = touches.pageX;
 tapObj.pageY = touches.pageY;
 tapObj.clientX = touches.clientX;
 tapObj.clientY = touches.clientY;
 self.time = +new Date();
},
touchend : function(e,self) {
 var touches = e.changedTouches[0];
 var tapObj = self.tapObj;
 self.time = +new Date() - self.time;
 tapObj.distanceX = tapObj.pageX - touches.pageX;
 tapObj.distanceY = tapObj.pageY - touches.pageY;
 
 if (self.isTap(tapObj))
  self.handler(e);
}

   

最後有個大問題，如何能讓我們的expression可接受傳參？

<ul>
 <li v-for="el in list"
  v-tap="args($index,el,$event)"
   >
  {{el.name}}---{{el.age}}
 </li>
</ul>

   

那就要在我們的directive上加一個屬性acceptStatement:true（詳見文檔acceptStatement）

總結
寫了這個心得分享給大家。
1.在update裡的this指向是directive實例，而不是vm，也不是dom
2.在directive('name',{}) 物件裡可自訂屬性和方法。呼叫就是self.xxx
3.開啟自訂指令接受內聯語句acceptStatement:true
4.最後的介面別忘了Vue.use(obj)
我這裡沒有對v-tap.stop， v-tap.prevent ，v-tap.stop.prevent做處理，大家可以自己實現！也灰常簡單。