自定義指令
Vue是不建議大家直接操作DOM的唤衫,但是Vue 允許你注冊自定義指令遥皂,實(shí)質(zhì)上是讓你教 Vue 一些新技巧:怎樣將數(shù)據(jù)的變化映射到 DOM 的行為畏陕。你可以使用Vue.directive(id, definition)的方法傳入指令id和定義對象來注冊一個全局自定義指令横媚。定義對象需要提供一些鉤子函數(shù)(可選的):
- bind: 僅調(diào)用一次考赛,當(dāng)指令第一次綁定元素的時候。
- update: 第一次是緊跟在 bind 之后調(diào)用今豆,獲得的參數(shù)是綁定的初始值侈沪;以后每當(dāng)綁定的值發(fā)生變化就會被調(diào)用,獲得新值與舊值兩個參數(shù)晚凿。
- unbind:僅調(diào)用一次亭罪,當(dāng)指令解綁元素的時候。
Vue.directive('my-directive', {
bind: function () {
// 做綁定的準(zhǔn)備工作
// 比如添加事件監(jiān)聽器歼秽,或是其他只需要執(zhí)行一次的復(fù)雜操作
},
update: function (newValue, oldValue) {
// 根據(jù)獲得的新值執(zhí)行對應(yīng)的更新
// 對于初始值也會被調(diào)用一次
},
unbind: function () {
// 做清理工作
// 比如移除在 bind() 中添加的事件監(jiān)聽器
}
})
一旦注冊好自定義指令应役,就可以在 Vue.js 模板中來使用它(需要添加 Vue.js 的指令前綴,默認(rèn)為 v-)
<div v-my-directive="someValue"></div>
如果只需要 update 函數(shù)燥筷,就可以只傳入一個函數(shù)箩祥,而不用傳定義對象。
Vue.directive('my-directive', function (value) {
// 這個函數(shù)會被作為 update() 函數(shù)使用
})
所有的鉤子函數(shù)會被復(fù)制到實(shí)際的指令對象中肆氓,而這個指令對象將會是所有鉤子函數(shù)的this上下文環(huán)境袍祖。指令對象上暴露了一些有用的公開屬性。這些屬性是只讀的谢揪,不要修改它們蕉陋。你也可以給指令對象附加自定義的屬性捐凭,但是注意不要覆蓋已有的內(nèi)部屬性。
- el: 指令綁定的元素
- vm: 擁有該指令的上下文 ViewModel
- expression: 指令的表達(dá)式凳鬓,不包括參數(shù)和過濾器
- arg: 指令的參數(shù)
- raw: 未被解析的原始表達(dá)式
- name: 不帶前綴的指令名
//使用指令對象屬性
<html>
<head lang="en">
<meta charset="UTF-8">
<title></title>
<script src="vue.min.js"></script>
</head>
<body>
<div id="demo" v-demo-directive="LightSlateGray: msg"></div>
<script>
Vue.directive('demoDirective', {
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!'
}
})
</script>
</body>
</html>
多重從句
同一個特性內(nèi)部茁肠,逗號分隔的多個從句將被綁定為多個指令實(shí)例。在下面的代碼中缩举,指令會被創(chuàng)建和調(diào)用兩次:
<div v-demo="color: 'white', text: 'hello!'"></div>
如果想要用單個指令實(shí)例處理多個參數(shù)垦梆,可以利用字面量對象作為表達(dá)式:
<div v-demo="{color: 'white', text: 'hello!'}"></div>
Vue.directive('demo', function (value) {
console.log(value) // Object {color: 'white', text: 'hello!'}
})
字面指令
如果在創(chuàng)建自定義指令的時候傳入 isLiteral: true
,那么特性值就會被看成直接字符串仅孩,并被賦值給該指令的 expression
托猩。字面指令不會試圖建立數(shù)據(jù)監(jiān)視。
<div v-literal-dir="foo"></div>
Vue.directive('literal-dir', {
isLiteral: true,
bind: function () {
console.log(this.expression) // 'foo'
}
})
動態(tài)字面指令
然而辽慕,在字面指令含有 Mustache 標(biāo)簽的情形下站刑,指令的行為如下:
- 指令實(shí)例會有一個屬性,
this._isDynamicLiteral
被設(shè)為true鼻百; - 如果沒有提供update函數(shù),Mustache 表達(dá)式只會被求值一次摆尝,并將該值賦給this.expression温艇。不會對表達(dá)式進(jìn)行數(shù)據(jù)監(jiān)視。
- 如果提供了update函數(shù)堕汞,指令將會為表達(dá)式建立一個數(shù)據(jù)監(jiān)視勺爱,并且在計算結(jié)果變化的時候調(diào)用update。
雙向指令
如果指令想向 Vue 實(shí)例寫回數(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)
}
})
內(nèi)聯(lián)語句
傳入 acceptStatement: true
可以讓自定義指令像 v-on 一樣接受內(nèi)聯(lián)語句:
<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.
}
})
此功能比較容易搞出問題人灼,請謹(jǐn)慎使用围段,反正我是沒在開發(fā)中用過hhh。
深度數(shù)據(jù)觀察
如果希望在一個對象上使用自定義指令投放,并且當(dāng)對象內(nèi)部嵌套的屬性發(fā)生變化時也能夠觸發(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)部嵌套的屬性變化時也會調(diào)用此函數(shù)
}
})
元素指令
有時候灸芳,我們可能想要我們的指令可以以自定義元素的形式被使用涝桅,而不是作為一個特性。元素指令可以看做是一個輕量的自定義組件烙样》胨欤可以像下面這樣注冊一個自定義的元素指令:
Vue.elementDirective('my-directive', {
// 和普通指令的 API 一致
bind: function () {
// 對 this.el 進(jìn)行操作...
}
})
使用時我們不再用這樣的寫法:
<div v-my-directive></div>
而是寫成:
<my-directive></my-directive>
元素指令不能接受參數(shù)或表達(dá)式,但是它可以讀取元素的特性谒获,來決定它的行為蛤肌。與通常的指令有個很大的不同壁却,元素指令是終結(jié)性的,這意味著寻定,一旦 Vue 遇到一個元素指令儒洛,它將跳過對該元素和其子元素的編譯 - 即只有該元素指令本身可以操作該元素及其子元素。