基礎

除了內(nèi)置指令，Vue.js 也允許注冊自定義指令。自定義指令提供一種機制將數(shù)據(jù)的變化映射為 DOM 行為。

可以用 Vue.directive(id, definition) 方法注冊一個全局自定義指令，它接收兩個參數(shù)指令 ID 與定義對象。也可以用組件的 directives 選項注冊一個局部自定義指令。

鉤子函數(shù)

定義對象可以提供幾個鉤子函數(shù)（都是可選的）：

 •bind：只調(diào)用一次，在指令第一次綁定到元素上時調(diào)用。

 •update： 在 bind 之后立即以初始值為參數(shù)第一次調(diào)用，之后每當綁定值變化時調(diào)用，參數(shù)為新值與舊值。

 •unbind：只調(diào)用一次，在指令從元素上解綁時調(diào)用。

 示例

Vue.directive('my-directive', {
 bind: function () {
  // 準備工作
  // 例如，添加事件處理器或只需要運行一次的高耗任務
 },
 update: function (newValue, oldValue) {
  // 值更新時的工作
  // 也會以初始值為參數(shù)調(diào)用一次
 },
 unbind: function () {
  // 清理工作
  // 例如，刪除 bind() 添加的事件監(jiān)聽器
 }
})

在注冊之后，便可以在 Vue.js 模板中這樣用（記著添加前綴 v-）：

<div v-my-directive="someValue"></div>

當只需要 update 函數(shù)時，可以傳入一個函數(shù)替代定義對象：

Vue.directive('my-directive', function (value) {
 // 這個函數(shù)用作 update()
})

指令實例屬性

所有的鉤子函數(shù)將被復制到實際的指令對象中，鉤子內(nèi) this 指向這個指令對象。這個對象暴露了一些有用的屬性：
 •el: 指令綁定的元素。
 •vm: 擁有該指令的上下文 ViewModel。
 •expression: 指令的表達式，不包括參數(shù)和過濾器。
 •arg: 指令的參數(shù)。
 •name: 指令的名字，不包含前綴。
 •modifiers: 一個對象，包含指令的修飾符。
 •descriptor: 一個對象，包含指令的解析結(jié)果。 

你應當將這些屬性視為只讀的，不要修改它們。你也可以給指令對象添加自定義屬性，但是注意不要覆蓋已有的內(nèi)部屬性。

示例：

<div id="demo" v-demo:hello.a.b="msg"></div>

Vue.directive('demo', {
 bind: function () {
  console.log('demo bound!')
 },
 update: function (value) {
  this.el.innerHTML =
   'name - '    + this.name + '<br>' +
   'expression - ' + this.expression + '<br>' +
   'argument - '  + this.arg + '<br>' +
   'modifiers - ' + JSON.stringify(this.modifiers) + '<br>' +
   'value - '   + value
 }
})
var demo = new Vue({
 el: '#demo',
 data: {
  msg: 'hello!'
 }
})

對象字面量

如果指令需要多個值，可以傳入一個 JavaScript 對象字面量。記住，指令可以使用任意合法的 JavaScript 表達式：

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

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

字面修飾符

當指令使用了字面修飾符，它的值將按普通字符串處理并傳遞給 update 方法。update 方法將只調(diào)用一次，因為普通字符串不能響應數(shù)據(jù)變化。

<div v-demo.literal="foo bar baz">

Vue.directive('demo', function (value) {
 console.log(value) // "foo bar baz"
})

元素指令

有時我們想以自定義元素的形式使用指令，而不是以特性的形式。這與 Angular 的 “E” 指令非常相似。元素指令可以看做是一個輕量組件?？梢韵裣旅孢@樣注冊一個自定義元素指令：

Vue.elementDirective('my-directive', {
 // API 同普通指令
 bind: function () {
  // 操作 this.el...
 }
})

不這樣寫：

<div v-my-directive></div>

這樣寫：

<my-directive></my-directive>

元素指令不能接受參數(shù)或表達式，但是它可以讀取元素的特性從而決定它的行為。

迥異于普通指令，元素指令是終結(jié)性的，這意味著，一旦 Vue 遇到一個元素指令，它將跳過該元素及其子元素——只有該元素指令本身可以操作該元素及其子元素。

高級選項

params

自定義指令可以接收一個 params 數(shù)組，指定一個特性列表，Vue 編譯器將自動提取綁定元素的這些特性。例如：

<div v-example a="hi"></div>

Vue.directive('example', {
 params: ['a'],
 bind: function () {
  console.log(this.params.a) // -> "hi"
 }
})

此 API 也支持動態(tài)屬性。this.params[key] 會自動保持更新。另外，可以指定一個回調(diào)，在值變化時調(diào)用：

<div v-example v-bind:a="someValue"></div>

Vue.directive('example', {
 params: ['a'],
 paramWatchers: {
  a: function (val, oldVal) {
   console.log('a changed!')
  }
 }
})

類似于 props，指令參數(shù)的名字在 JavaScript 中使用 camelCase 風格，在 HTML 中對應使用 kebab-case 風格。例如，假設在模板里有一個參數(shù) `disable-effect`，在 JavaScript 里以 `disableEffect` 訪問它。

deep

如果自定義指令用在一個對象上，當對象內(nèi)部屬性變化時要觸發(fā) update，則在指令定義對象中指定 deep: true。

<div v-my-directive="obj"></div>

Vue.directive('my-directive', {
 deep: true,
 update: function (obj) {
  // 在 `obj` 的嵌套屬性變化時調(diào)用
 }
})

twoWay

如果指令想向 Vue 實例寫回數(shù)據(jù)，則在指令定義對象中指定 twoWay: true 。該選項允許在指令中使用 this.set(value):

Vue.directive('example', {
 twoWay: true,
 bind: function () {
  this.handler = function () {
   // 將數(shù)據(jù)寫回 vm
   // 如果指令這樣綁定 v-example="a.b.c"
   // 它將用給定值設置 `vm.a.b.c`
   this.set(this.el.value)
  }.bind(this)
  this.el.addEventListener('input', this.handler)
 },
 unbind: function () {
  this.el.removeEventListener('input', this.handler)
 }
})

acceptStatement

傳入 acceptStatement:true 可以讓自定義指令接受內(nèi)聯(lián)語句，就像 v-on 那樣：

<div v-my-directive="a++"></div>

Vue.directive('my-directive', {
 acceptStatement: true,
 update: function (fn) {
  // 傳入值是一個函數(shù)
  // 在調(diào)用它時將在所屬實例作用域內(nèi)計算 "a++" 語句
 }
})

明智地使用，因為通常你要在模板中避免副效應。

terminal

1.0.19+ 

Vue 通過遞歸遍歷 DOM 樹來編譯模塊。但是當它遇到 terminal 指令時會停止遍歷這個元素的后代元素。這個指令將接管編譯這個元素及其后代元素的任務。v-if 和 v-for 都是 terminal 指令。

編寫自定義 terminal 指令是一個高級話題，需要較好的理解 Vue 的編譯流程，但這不是說不可能編寫自定義 terminal 指令。用 terminal: true 指定自定義 terminal 指令，可能還需要用 Vue.FragmentFactory 來編譯 partial。下面是一個自定義 terminal 指令，它編譯它的內(nèi)容模板并將結(jié)果注入到頁面的另一個地方：

var FragmentFactory = Vue.FragmentFactory
var remove = Vue.util.remove
var createAnchor = Vue.util.createAnchor

Vue.directive('inject', {
 terminal: true,
 bind: function () {
  var container = document.getElementById(this.arg)
  this.anchor = createAnchor('v-inject')
  container.appendChild(this.anchor)
  remove(this.el)
  var factory = new FragmentFactory(this.vm, this.el)
  this.frag = factory.create(this._host, this._scope, this._frag)
  this.frag.before(this.anchor)
 },
 unbind: function () {
  this.frag.remove()
  remove(this.anchor)
 }
})

<div id="modal"></div>
...
<div v-inject:modal>
 <h1>header</h1>
 <p>body</p>
 <p>footer</p>
</div>

如果你想編寫自定義 terminal 指令，建議你通讀內(nèi)置 terminal 指令的源碼，如 v-if 和 v-for，以便更好地了解 Vue 的內(nèi)部機制。

priority

可以給指令指定一個優(yōu)先級。如果沒有指定，普通指令默認是 1000， terminal 指令默認是 2000。同一個元素上優(yōu)先級高的指令會比其它指令處理得早一些。優(yōu)先級一樣的指令按照它在元素特性列表中出現(xiàn)的順序依次處理，但是不能保證這個順序在不同的瀏覽器中是一致的。

可以在 API 中查看內(nèi)置指令的優(yōu)先級。另外，流程控制指令 v-if 和 v-for 在編譯過程中始終擁有最高的優(yōu)先級。

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

最新評論