Vue.js 允許你注冊(cè)自定義指令,實(shí)質(zhì)上是讓你教 Vue 一些新技巧:怎樣將數(shù)據(jù)的變化映射到 DOM 的行為。你可以使用 Vue.directive(id, definition) 的方法傳入指令 id 和定義對(duì)象來(lái)注冊(cè)一個(gè)全局自定義指令。定義對(duì)象需要提供一些鉤子函數(shù)(全部可選):
bind: 僅調(diào)用一次,當(dāng)指令第一次綁定元素的時(shí)候。update: 第一次是緊跟在 bind 之后調(diào)用,獲得的參數(shù)是綁定的初始值;以后每當(dāng)綁定的值發(fā)生變化就會(huì)被調(diào)用,獲得新值與舊值兩個(gè)參數(shù)。unbind:僅調(diào)用一次,當(dāng)指令解綁元素的時(shí)候。Example
```Vue.directive('my-directive', { bind: function () { // 做綁定的準(zhǔn)備工作 // 比如添加事件監(jiān)聽(tīng)器,或是其他只需要執(zhí)行一次的復(fù)雜操作 }, update: function (newValue, oldValue) { // 根據(jù)獲得的新值執(zhí)行對(duì)應(yīng)的更新 // 對(duì)于初始值也會(huì)被調(diào)用一次 }, unbind: function () { // 做清理工作 // 比如移除在 bind() 中添加的事件監(jiān)聽(tīng)器 } })
一旦注冊(cè)好自定義指令,你就可以在 Vue.js 模板中像這樣來(lái)使用它(需要添加 Vue.js 的指令前綴,默認(rèn)為 `v-`):
`<div v-my-directive="someValue"></div>`
如果你只需要 `update` 函數(shù),你可以只傳入一個(gè)函數(shù),而不用傳定義對(duì)象:
```Vue.directive('my-directive', function (value) {
// 這個(gè)函數(shù)會(huì)被作為 update() 函數(shù)使用
})```
所有的鉤子函數(shù)會(huì)被復(fù)制到實(shí)際的**指令對(duì)象**中,而這個(gè)指令對(duì)象將會(huì)是所有鉤子函數(shù)的 `this` 上下文環(huán)境。指令對(duì)象上暴露了一些有用的公開(kāi)屬性:
- **el**: 指令綁定的元素
- **vm**: 擁有該指令的上下文 ViewModel
- **expression**: 指令的表達(dá)式,不包括參數(shù)和過(guò)濾器
- **arg**: 指令的參數(shù)
- **raw**: 未被解析的原始表達(dá)式
- **name**: 不帶前綴的指令名
>這些屬性是只讀的,不要修改它們。你也可以給指令對(duì)象附加自定義的屬性,但是注意不要覆蓋已有的內(nèi)部屬性。
使用指令對(duì)象屬性的示例:
`<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!
### 多重從句
同一個(gè)特性?xún)?nèi)部,逗號(hào)分隔的多個(gè)從句將被綁定為多個(gè)指令實(shí)例。在下面的例子中,指令會(huì)被創(chuàng)建和調(diào)用兩次:
`<div v-demo="color: 'white', text: 'hello!'"></div>`
如果想要用單個(gè)指令實(shí)例處理多個(gè)參數(shù),可以利用字面量對(duì)象作為表達(dá)式:
`<div v-demo="{color: 'white', text: 'hello!'}"></div>`
```Vue.directive('demo', function (value) {
console.log(value) // Object {color: 'white', text: 'hello!'}
})```
## 字面指令
如果在創(chuàng)建自定義指令的時(shí)候傳入 `isLiteral: true`,那么特性值就會(huì)被看成直接字符串,并被賦值給該指令的 `expression`。字面指令不會(huì)試圖建立數(shù)據(jù)監(jiān)視。
**Example**:
`<div v-literal-dir="foo"></div>`
```Vue.directive('literal-dir', {
isLiteral: true,
bind: function () {
console.log(this.expression) // 'foo'
}
})```
### 動(dòng)態(tài)字面指令
然而,在字面指令含有 `Mustache` 標(biāo)簽的情形下,指令的行為如下:
- 指令實(shí)例會(huì)有一個(gè)屬性,`this._isDynamicLiteral` 被設(shè)為 `true`;
- 如果沒(méi)有提供 `update` 函數(shù),`Mustache` 表達(dá)式只會(huì)被求值一次,并將該值賦給 `this.expression` 。不會(huì)對(duì)表達(dá)式進(jìn)行數(shù)據(jù)監(jiān)視。
- 如果提供了 `update` 函數(shù),指令將會(huì)為表達(dá)式建立一個(gè)數(shù)據(jù)監(jiān)視,并且在計(jì)算結(jié)果變化的時(shí)候調(diào)用 `update`。
## 雙向指令
如果你的指令想向 Vue 實(shí)例寫(xiě)回?cái)?shù)據(jù),你需要傳入 `twoWay: true` 。該選項(xiàng)允許在指令中使用 `this.set(value)`。
```Vue.directive('example', {
twoWay: true,
bind: function () {
this.handler = function () {
// 把數(shù)據(jù)寫(xiě)回 vm
// 如果指令這樣綁定 v-example="a.b.c",
// 這里將會(huì)給 `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)
}
})```
## 內(nèi)聯(lián)語(yǔ)句
傳入 `acceptStatement: true` 可以讓自定義指令像 `v-on` 一樣接受內(nèi)聯(lián)語(yǔ)句:
`<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.
}
})```
但是請(qǐng)明智地使用此功能,因?yàn)橥ǔN覀兿M苊庠谀0逯挟a(chǎn)生副作用。
## 深度數(shù)據(jù)觀(guān)察
如果你希望在一個(gè)對(duì)象上使用自定義指令,并且當(dāng)對(duì)象內(nèi)部嵌套的屬性發(fā)生變化時(shí)也能夠觸發(fā)指令的 `update` 函數(shù),那么你就要在指令的定義中傳入 `deep: true`。
`<div v-my-directive="obj"></div>`
```Vue.directive('my-directive', {
deep: true,
update: function (obj) {
// 當(dāng) obj 內(nèi)部嵌套的屬性變化時(shí)也會(huì)調(diào)用此函數(shù)
}
})```
## 指令優(yōu)先級(jí)
你可以選擇給指令提供一個(gè)優(yōu)先級(jí)數(shù)(默認(rèn)是 0)。同一個(gè)元素上優(yōu)先級(jí)越高的指令會(huì)比其他的指令處理得早一些。優(yōu)先級(jí)一樣的指令會(huì)按照其在元素特性列表中出現(xiàn)的順序依次處理,但是不能保證這個(gè)順序在不同的瀏覽器中是一致的。
通常來(lái)說(shuō)作為用戶(hù),你并不需要關(guān)心內(nèi)置指令的優(yōu)先級(jí),如果你感興趣的話(huà),可以參閱源碼。邏輯控制指令 `v-repeat`, `v-if` 被視為 “終結(jié)性指令”,它們?cè)诰幾g過(guò)程中始終擁有最高的優(yōu)先級(jí)。
## 元素指令
有時(shí)候,我們可能想要我們的指令可以以自定義元素的形式被使用,而不是作為一個(gè)特性。這與 `Angular` 的 `E` 類(lèi)指令的概念非常相似。元素指令可以看做是一個(gè)輕量的自定義組件(后面會(huì)講到)。你可以像下面這樣注冊(cè)一個(gè)自定義的元素指令:
```Vue.elementDirective('my-directive', {
// 和普通指令的 API 一致
bind: function () {
// 對(duì) this.el 進(jìn)行操作...
}
})
使用時(shí)我們不再用這樣的寫(xiě)法:
<div v-my-directive></div>
而是寫(xiě)成:
<my-directive></my-directive>
元素指令不能接受參數(shù)或表達(dá)式,但是它可以讀取元素的特性,來(lái)決定它的行為。
與通常的指令有個(gè)很大的不同,元素指令是終結(jié)性的,這意味著,一旦 Vue 遇到一個(gè)元素指令,它將跳過(guò)對(duì)該元素和其子元素的編譯 - 即只有該元素指令本身可以操作該元素及其子元素。
下面,我們來(lái)看怎樣寫(xiě)一個(gè) 自定義過(guò)濾器。