[toc] ## 基礎 Vue.js 允許你注冊自定義指令，實質上是讓你教 Vue 一些新技巧：怎樣將數據的變化映射到 DOM 的行為。你可以使用 Vue.directive(id, definition) 的方法傳入指令 id 和定義對象來注冊一個全局自定義指令。定義對象需要提供一些鉤子函數（全部可選）： - bind： 僅調用一次，當指令第一次綁定元素的時候。 - update： 第一次是緊跟在 bind 之后調用，獲得的參數是綁定的初始值；以后每當綁定的值發生變化就會被調用，獲得新值與舊值兩個參數。 - unbind：僅調用一次，當指令解綁元素的時候。 Example ~~~ Vue.directive('my-directive', { bind: function () { // 做綁定的準備工作 // 比如添加事件監聽器，或是其他只需要執行一次的復雜操作 }, update: function (newValue, oldValue) { // 根據獲得的新值執行對應的更新 // 對于初始值也會被調用一次 }, unbind: function () { // 做清理工作 // 比如移除在 bind() 中添加的事件監聽器 } }) ~~~ 一旦注冊好自定義指令，你就可以在 Vue.js 模板中像這樣來使用它（需要添加 Vue.js 的指令前綴，默認為 `v-`）： ~~~ <div v-my-directive="someValue"></div> ~~~ 如果你只需要 `update` 函數，你可以只傳入一個函數，而不用傳定義對象： ~~~ Vue.directive('my-directive', function (value) { // 這個函數會被作為 update() 函數使用 }) ~~~ 所有的鉤子函數會被復制到實際的**指令對象**中，而這個指令對象將會是所有鉤子函數的 `this` 上下文環境。指令對象上暴露了一些有用的公開屬性： - **el**： 指令綁定的元素 - **vm**： 擁有該指令的上下文 ViewModel - **expression**： 指令的表達式，不包括參數和過濾器 - **arg**： 指令的參數 - **raw**： 未被解析的原始表達式 - **name**： 不帶前綴的指令名 > 這些屬性是只讀的，不要修改它們。你也可以給指令對象附加自定義的屬性，但是注意不要覆蓋已有的內部屬性。 使用指令對象屬性的示例： ~~~ <div id="demo" v-demo="LightSlateGray : msg"></div> Vue.directive('demo', { bind: function () { this.el.style.color = '#fff' this.el.style.backgroundColor = this.arg }, update: function (value) { this.el.innerHTML = 'name - ' + this.name + '<br>' + 'raw - ' + this.raw + '<br>' + 'expression - ' + this.expression + '<br>' + 'argument - ' + this.arg + '<br>' + 'value - ' + value } }) var demo = new Vue({ el: '#demo', data: { msg: 'hello!' } }) ~~~ **Result** ~~~ - name - demo - raw - LightSlateGray：msg - expression - msg - argument - LightSlateGray - value - hello! ~~~ ## 多重從句 同一個特性內部，逗號分隔的多個從句將被綁定為多個指令實例。在下面的例子中，指令會被創建和調用兩次： ~~~ <div v-demo="color: 'white', text: 'hello!'"></div> ~~~ 如果想要用單個指令實例處理多個參數，可以利用字面量對象作為表達式： ~~~ <div v-demo="{color: 'white', text: 'hello!'}"></div> Vue.directive('demo', function (value) { console.log(value) // Object {color: 'white', text: 'hello!'} }) ~~~ ## 字面指令 如果在創建自定義指令的時候傳入 `isLiteral: true`，那么特性值就會被看成直接字符串，并被賦值給該指令的 `expression`。字面指令不會試圖建立數據監視。 **Example**： ~~~ <div v-literal-dir="foo"></div> Vue.directive('literal-dir', { isLiteral: true, bind: function () { console.log(this.expression) // 'foo' } }) ~~~ ## 動態字面指令 然而，在字面指令含有 `Mustache` 標簽的情形下，指令的行為如下： - 指令實例會有一個屬性，`this._isDynamicLiteral` 被設為 `true`； - 如果沒有提供 `update` 函數，`Mustache` 表達式只會被求值一次，并將該值賦給 `this.expression` 。不會對表達式進行數據監視。 - 如果提供了 `update` 函數，指令將會為表達式建立一個數據監視，并且在計算結果變化的時候調用 `update`。 ## 雙向指令 如果你的指令想向 Vue 實例寫回數據，你需要傳入 `twoWay: true` 。該選項允許在指令中使用 `this.set(value)`。 ~~~ Vue.directive('example', { twoWay: true, bind: function () { this.handler = function () { // 把數據寫回 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: true` 可以讓自定義指令像 `v-on` 一樣接受內聯語句： ~~~ <div v-my-directive="a++"></div> Vue.directive('my-directive', { acceptStatement: true, update: function (fn) { // the passed in value is a function which when called, // will execute the "a++" statement in the owner vm's // scope. } }) ~~~ 但是請明智地使用此功能，因為通常我們希望避免在模板中產生副作用。 ## 深度數據觀察 如果你希望在一個對象上使用自定義指令，并且當對象內部嵌套的屬性發生變化時也能夠觸發指令的 `update` 函數，那么你就要在指令的定義中傳入 `deep: true`。 ~~~ <div v-my-directive="obj"></div> Vue.directive('my-directive', { deep: true, update: function (obj) { // 當 obj 內部嵌套的屬性變化時也會調用此函數 } }) ~~~ ## 指令優先級 你可以選擇給指令提供一個優先級數（默認是 0）。同一個元素上優先級越高的指令會比其他的指令處理得早一些。優先級一樣的指令會按照其在元素特性列表中出現的順序依次處理，但是不能保證這個順序在不同的瀏覽器中是一致的。 通常來說作為用戶，你并不需要關心內置指令的優先級，如果你感興趣的話，可以參閱源碼。邏輯控制指令 `v-repeat`， `v-if` 被視為 “終結性指令”，它們在編譯過程中始終擁有最高的優先級。 ## 元素指令 有時候，我們可能想要我們的指令可以以自定義元素的形式被使用，而不是作為一個特性。這與 `Angular` 的 `E` 類指令的概念非常相似。元素指令可以看做是一個輕量的自定義組件（后面會講到）。你可以像下面這樣注冊一個自定義的元素指令： ~~~ Vue.elementDirective('my-directive', { // 和普通指令的 API 一致 bind: function () { // 對 this.el 進行操作... } }) ~~~ 使用時我們不再用這樣的寫法： ~~~ <div v-my-directive></div> ~~~ 而是寫成： ~~~ <my-directive></my-directive> ~~~ 元素指令不能接受參數或表達式，但是它可以讀取元素的特性，來決定它的行為。 與通常的指令有個很大的不同，元素指令是終結性的，這意味著，一旦 Vue 遇到一個元素指令，它將跳過對該元素和其子元素的編譯 - 即只有該元素指令本身可以操作該元素及其子元素。