DIV CSS 佈局教程網

手寫 v-tap 插件:用 Vue 自定義指令實現移動端點擊手勢
編輯:關於JavaScript     

放棄 jQuery,擁抱 MVVM,擁抱元件化。

vue-touch 是基於 hammer 的,對於只需要簡單手勢的頁面來說體積過於龐大。於是我決定自己實作一個最常用的手勢:tap。順著自定義指令與插件的官方文件,最終完成了一個 v-tap 指令。

先讀文件:只需要三個 API

自定義指令與插件的官方說明寫得算是簡潔,這裡不贅述。這個插件只用到三個 API,建議先了解它們,否則下面的程式碼會看得有點吃力。

指令部分:update(nVal, oVal)、acceptStatement

插件部分:Vue.use()

Vue 插件的標準格式

寫 Vue 插件的方式和寫 jQuery 插件不太一樣,官方文件給的範式是:

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                 // CommonJS
  } else if (typeof define == "function" && define.amd) {
    define([], function () { return vueTouch })  // AMD
  } else if (window.Vue) {
    window.VueTouch = vueTouch
    Vue.use(vueTouch)                          // 直接引入 script
  }
})()

把無關程式碼移除後可以發現,格式就是這樣,剩下的部分用一般的 JS 功底撰寫即可。

補充一下 isFn: true:這個屬性我在文件中沒查到明確說明,推測是一種標記,代表該指令需要一個函式類型的表達式(表達式是指令的值,可參考指令的實例屬性說明)。

開始動手

先照插件格式把外層骨架寫好:

;(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 能接收參數、拿到我們的表達式,所以我把事件綁定與初始化都寫在 update 裡。

補充:也有人喜歡把 fn 掛在 this(這裡的 this 是 directive 實例)上,最後在 bind 中綁定事件。這個寫法我沒找到明確規範,暫不確定哪種更好。

update: function (fn) {
  var self = this;   // 存下 this,方便後續使用

  // 掛在 directive 上的屬性與方法,之後都能透過 self.xxx 取得
  self.tapObj = {};

  if (typeof fn !== 'function') {
    return console.error('The param of directive "v-tap" must be a function!');
  }

  self.handler = function (e) {
    e.tapObj = self.tapObj;   // 把 tap 資訊掛到原生 event 上,方便回呼中取得
    fn.call(self, e);
  };

  // 由於只有 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: function () {
  var tapObj = this.tapObj;
  // 時長足夠短、位移足夠小,才算 tap
  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);
  }
}

讓表達式能接受參數

最後一個問題:怎麼讓我們的表達式可以傳參數?

<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 這些修飾符,有興趣可以自己補上,實作起來並不難。

專案 GitHub:https://github.com/MeCKodo/vue-tap

補充:這個判斷邏輯的不足

用「時長 < 150ms 且位移 < 2px」來判定 tap 是常見做法,但有幾個情境會誤判,值得留意:

  • 長按(long press)的正確處理方式其實應該主動觸發一個獨立事件,而不是靜默失敗——使用者按住兩秒然後放開,什麼都沒發生,體驗上是困惑的。
  • 位移閾值只看首尾兩點。使用者緩慢拖出去再拖回來,首尾位移接近 0,會被誤判成 tap。更嚴謹的做法是在 touchmove 中持續追蹤最大位移。
  • 多指手勢沒有判斷 e.touches.length,兩指縮放時可能誤觸。

另外提醒:在 Vue 2.x 中自定義指令的鉤子已改名為 bind/inserted/update/componentUpdated/unbind,而「表達式函式化」也改用 el.addEventListener 搭配 directive 的 bind 完成,不再是 isFn 這類 1.x 的寫法。移轉時請對照版本文件。

以上是本文的全部內容,希望對大家的學習有所幫助。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved