Vue.js 自定義指令
除了默認設置的核心指令( v-model 和 v-show ), Vue 也允許註冊自定義指令。
下面我們註冊一個全局指令 v-focus, 該指令的功能是在頁面加載時,元素獲得焦點:
<body>
<!-- 自定義指令 - 當頁面加載時,輸入框自動獲取焦點 -->
<div id="mydiv1">
<input v-focus>
</div>
<script>
// 註冊一個全局的自定義指令
// Vue.directive('focus', {
// // Vue監聽到當元素插入到DOM中時
// inserted: function (el) {
// // 此控件獲取焦點
// el.focus()
// }
// });
new Vue({
el: "#mydiv1",
// 註冊一個局部的自定義指令,該指令只能在此實例中使用
directives:{
focus:{
inserted:function (el) {
el.focus()
}
}
}
});
</script>
</body>
鉤子
鉤子函數
指令定義函數提供了幾個鉤子函數(可選):
-
bind
: 只調用一次,指令第一次綁定到元素時調用,用這個鉤子函數可以定義一個在綁定時執行一次的初始化動作。 -
inserted
: 被綁定元素插入父節點時調用(父節點存在即可調用,不必存在於 document 中)。 -
update
: 被綁定元素所在的模板更新時調用,而不論綁定值是否變化。通過比較更新前後的綁定值,可以忽略不必要的模板更新(詳細的鉤子函數參數見下)。 -
componentUpdated
: 被綁定元素所在模板完成一次更新週期時調用。 -
unbind
: 只調用一次, 指令與元素解綁時調用。
鉤子函數參數
鉤子函數的參數有:
- 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: 傳給指令的參數。例如
v-my-directive:foo
, arg 的值是"foo"
。 - modifiers: 一個包含修飾符的對象。 例如:
v-my-directive.foo.bar
, 修飾符對象 modifiers 的值是{ foo: true, bar: true }
。
- name: 指令名,不包括
- vnode: Vue 編譯生成的虛擬節點。
- oldVnode: 上一個虛擬節點,僅在
update
和componentUpdated
鉤子中可用。
以下實例演示了這些參數的使用:
<div id="app" v-runoob:hello.a.b="message">
</div>
<script>
Vue.directive('runoob', {
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: '#app',
data: {
message: '菜鳥教程!'
}
})
</script>
有時候我們不需要其他鉤子函數,我們可以簡寫函數,如下格式:
Vue.directive('runoob', function (el, binding) {
// 設置指令的背景顏色
el.style.backgroundColor = binding.value.color
})
指令函數可接受所有合法的 JavaScript 表達式,以下實例傳入了 JavaScript 對象:
<div id="app">
<div v-runoob="{ color: 'green', text: '菜鳥教程!' }"></div>
</div>
<script>
Vue.directive('runoob', function (el, binding) {
// 簡寫方式設置文本及背景顏色
el.innerHTML = binding.value.text
el.style.backgroundColor = binding.value.color
})
new Vue({
el: '#app'
})
</script>