除了默認(rèn)設(shè)置的核心指令( v-model
和 v-show
),Vue 也允許注冊自定義指令。在Vue里,代碼復(fù)用的主要形式和抽象是組件。然而,有的情況下,仍然需要對純 DOM 元素進(jìn)行底層操作,這時候就會用到自定義指令。本文將詳細(xì)介紹Vue自定義指令
指令注冊
以一個input元素自動獲得焦點為例,當(dāng)頁面加載時,使用autofocus可以讓元素將獲得焦點 。但是autofocus在移動版Safari上不工作?,F(xiàn)在注冊一個使元素自動獲取焦點的指令
指令注冊類似于組件注冊,包括全局指令和局部指令兩種
【全局指令】
使用Vue.diretive()來全局注冊指令
// 注冊一個全局自定義指令 v-focusVue.directive('focus', { // 當(dāng)綁定元素插入到 DOM 中。 inserted: function (el) { // 聚焦元素 el.focus() } })
【局部指令】
也可以注冊局部指令,組件或Vue構(gòu)造函數(shù)中接受一個 directives
的選項
var vm = new Vue({ el: '#example', directives:{ focus:{ inserted: function (el) { el.focus() } } } })
然后可以在模板中任何元素上使用新的 v-focus
屬性
<p id="example"> <input v-focus></p>
<script>// 注冊一個全局自定義指令 v-focusVue.directive('focus', { // 當(dāng)綁定元素插入到 DOM 中。 inserted: function (el) { // 聚焦元素 el.focus() } })var vm = new Vue({ el: '#example', })</script>
鉤子函數(shù)
指令定義函數(shù)提供了幾個鉤子函數(shù)(可選)
【bind】
只調(diào)用一次,指令第一次綁定到元素時調(diào)用,用這個鉤子函數(shù)可以定義一個在綁定時執(zhí)行一次的初始化動作
【inserted】
被綁定元素插入父節(jié)點時調(diào)用(父節(jié)點存在即可調(diào)用,不必存在于 document 中)
【update】
所在組件的 VNode 更新時調(diào)用,但是可能發(fā)生在其孩子的 VNode 更新之前。指令的值可能發(fā)生了改變也可能沒有。但是可以通過比較更新前后的值來忽略不必要的模板更新
【componentUpdated】
所在組件的 VNode 及其孩子的 VNode 全部更新時調(diào)用
【unbind】
只調(diào)用一次, 指令與元素解綁時調(diào)用
鉤子函數(shù)參數(shù)
鉤子函數(shù)被賦予了以下參數(shù)
【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: 傳給指令的參數(shù)。例如 v-my-directive:foo, arg 的值是 "foo"。 modifiers: 一個包含修飾符的對象。 例如: v-my-directive.foo.bar, 修飾符對象 modifiers 的值是 { foo: true, bar: true }。
【vnode】
Vue 編譯生成的虛擬節(jié)點
【oldVnode】
上一個虛擬節(jié)點,僅在 update
和 componentUpdated
鉤子中可用
[注意]除了 el
之外,其它參數(shù)都是只讀的,盡量不要修改他們。如果需要在鉤子之間共享數(shù)據(jù),建議通過元素的 dataset 來進(jìn)行
下面是一個使用了這些參數(shù)的自定義鉤子樣例
<p id="example" v-demo:foo.a.b="message"></p>
<script>Vue.directive('demo', { 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: '#example', data: { message: 'hello!' } })</script>
【函數(shù)簡寫】
大多數(shù)情況下,可能想在bind
和update
鉤子上做重復(fù)動作,并且不想關(guān)心其它的鉤子函數(shù)。可以這樣寫:
Vue.directive('color-swatch', function (el, binding) { el.style.backgroundColor = binding.value })
【對象字面量】
如果指令需要多個值,可以傳入一個JS對象字面量。指令函數(shù)能夠接受所有合法類型的JS表達(dá)式
<p v-demo="{ color: 'white', text: 'hello!' }"></p>
Vue.directive('demo', function (el, binding) { console.log(binding.value.color) // => "white" console.log(binding.value.text) // => "hello!" })