Vue.js 2.0 自定義指令

自定義指令簡介

除了默認設置的核心指令( v-model 和 v-show ),Vue 也允許注冊自定義指令。注意，在 Vue2.0 里面，代碼復用的主要形式和抽象是組件——然而，有的情況下,你仍然需要對純 DOM 元素進行底層操作,這時候就會用到自定義指令。下面這個例子將聚焦一個 input 元素，像這樣：

當頁面加載時，元素將獲得焦點。事實上，你訪問后還沒點擊任何內(nèi)容，input 就獲得了焦點?，F(xiàn)在讓我們完善這個指令：

// 注冊一個全局自定義指令 v-focus
Vue.directive('focus', {
  // 當綁定元素插入到 DOM 中。
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})

也可以注冊局部指令，組件中接受一個 directives 的選項：

directives: {
  focus: {
    // 指令的定義---
  }
}

然后你可以在模板中任何元素上使用新的 v-focus 屬性：

<input v-focus>

鉤子函數(shù)

指令定義函數(shù)提供了幾個鉤子函數(shù)（可選）：

• bind: 只調(diào)用一次，指令第一次綁定到元素時調(diào)用，用這個鉤子函數(shù)可以定義一個在綁定時執(zhí)行一次的初始化動作。
• inserted: 被綁定元素插入父節(jié)點時調(diào)用（父節(jié)點存在即可調(diào)用，不必存在于 document 中）。
• update: 被綁定元素所在的模板更新時調(diào)用，而不論綁定值是否變化。通過比較更新前后的綁定值，可以忽略不必要的模板更新（詳細的鉤子函數(shù)參數(shù)見下）。
• componentUpdated: 被綁定元素所在模板完成一次更新周期時調(diào)用。
• unbind: 只調(diào)用一次， 指令與元素解綁時調(diào)用。

接下來我們來看一下鉤子函數(shù)的參數(shù) (包括 el，binding，vnode，oldVnode) 。

鉤子函數(shù)參數(shù)

鉤子函數(shù)被賦予了以下參數(shù)：

• el：指令所綁定的元素，可以用來直接操作 DOM 。
• binding：一個對象，包含以下屬性：
  • name: 指令名，不包括 v- 前綴。
  • value: 指令的綁定值， 例如： v-my-directive="1 + 1", value 的值是 2。
  • oldValue: 指令綁定的前一個值，僅在 update 和 componentUpdated 鉤子中可用。無論值是否改變都可用。
  • expression: 綁定值的字符串形式。 例如 v-my-directive="1 + 1" ， expression 的值是 "1 + 1"。
  • arg: 傳給指令的參數(shù)。例如 v-my-directive:foo， arg 的值是 "foo"。
  • modifiers: 一個包含修飾符的對象。 例如： v-my-directive.foo.bar, 修飾符對象 modifiers 的值是 { foo: true, bar: true }。
• vnode: Vue 編譯生成的虛擬節(jié)點，查閱 VNode API 了解更多詳情。
• oldVnode: 上一個虛擬節(jié)點，僅在 update 和 componentUpdated 鉤子中可用。

除了 el 之外，其它參數(shù)都應該是只讀的，盡量不要修改他們。如果需要在鉤子之間共享數(shù)據(jù)，建議通過元素的 dataset 來進行。

一個使用了這些參數(shù)的自定義鉤子樣例：

<div id="hook-arguments-example" v-demo:hello.a.b="message"></div>

Vue.directive('demo', {
  bind: function (el, binding, vnode) {
    var s = JSON.stringify
    el.innerHTML =
      'name: '       + s(binding.name) + '<br>' +
      'value: '      + s(binding.value) + '<br>' +
      'expression: ' + s(binding.expression) + '<br>' +
      'argument: '   + s(binding.arg) + '<br>' +
      'modifiers: '  + s(binding.modifiers) + '<br>' +
      'vnode keys: ' + Object.keys(vnode).join(', ')
  }
})
new Vue({
  el: '#hook-arguments-example',
  data: {
    message: 'hello!'
  }
})

結(jié)果：

name: "demo"
value: "hello!"
expression: "message"
argument: "hello"
modifiers: {"a":true,"b":true}
vnode keys: tag, data, children, text, elm, ns, context, functionalContext, key, componentOptions, child, parent, raw, isStatic, isRootInsert, isComment, isCloned, isOnce

函數(shù)簡寫

大多數(shù)情況下，我們可能想在 bind 和 update 鉤子上做重復動作，并且不想關(guān)心其它的鉤子函數(shù)?？梢赃@樣寫:

Vue.directive('color-swatch', function (el, binding) {
  el.style.backgroundColor = binding.value
})

對象字面量

如果指令需要多個值，可以傳入一個 JavaScript 對象字面量。記住，指令函數(shù)能夠接受所有合法類型的 Javascript 表達式。

<div v-demo="{ color: 'white', text: 'hello!' }"></div>

Vue.directive('demo', function (el, binding) {
  console.log(binding.value.color) // => "white"
  console.log(binding.value.text)  // => "hello!"
})