Vue.js每天必學之指令系統與自定義指令

NO IMAGE
1 Star2 Stars3 Stars4 Stars5 Stars 給文章打分!
Loading...

基礎

除了內建指令,Vue.js 也允許註冊自定義指令。自定義指令提供一種機制將資料的變化對映為 DOM 行為。

可以用 Vue.directive(id, definition) 方法註冊一個全域性自定義指令,它接收兩個引數指令 ID 與定義物件。也可以用元件的 directives 選項註冊一個區域性自定義指令。

鉤子函式

定義物件可以提供幾個鉤子函式(都是可選的):

 •bind:只呼叫一次,在指令第一次繫結到元素上時呼叫。

 •update: 在 bind 之後立即以初始值為引數第一次呼叫,之後每當繫結值變化時呼叫,引數為新值與舊值。

 •unbind:只呼叫一次,在指令從元素上解綁時呼叫。

 示例


Vue.directive('my-directive', {
bind: function () {
// 準備工作
// 例如,新增事件處理器或只需要執行一次的高耗任務
},
update: function (newValue, oldValue) {
// 值更新時的工作
// 也會以初始值為引數呼叫一次
},
unbind: function () {
// 清理工作
// 例如,刪除 bind() 新增的事件監聽器
}
})

在註冊之後,便可以在 Vue.js 模板中這樣用(記著新增字首 v-):

<div v-my-directive=”someValue”></div>

當只需要 update 函式時,可以傳入一個函式替代定義物件:


Vue.directive('my-directive', function (value) {
// 這個函式用作 update()
})

指令例項屬性

所有的鉤子函式將被複制到實際的指令物件中,鉤子內 this 指向這個指令物件。這個物件暴露了一些有用的屬性:
 •el: 指令繫結的元素。
 •vm: 擁有該指令的上下文 ViewModel。
 •expression: 指令的表示式,不包括引數和過濾器。
 •arg: 指令的引數。
 •name: 指令的名字,不包含字首。
 •modifiers: 一個物件,包含指令的修飾符。
 •descriptor: 一個物件,包含指令的解析結果。 

你應當將這些屬性視為只讀的,不要修改它們。你也可以給指令物件新增自定義屬性,但是注意不要覆蓋已有的內部屬性。

示例:

<div id=”demo” v-demo:hello.a.b=”msg”></div>


Vue.directive('demo', {
bind: function () {
console.log('demo bound!')
},
update: function (value) {
this.el.innerHTML =
'name - '      this.name   '<br>'  
'expression - '   this.expression   '<br>'  
'argument - '    this.arg   '<br>'  
'modifiers - '   JSON.stringify(this.modifiers)   '<br>'  
'value - '     value
}
})
var demo = new Vue({
el: '#demo',
data: {
msg: 'hello!'
}
})

物件字面量

如果指令需要多個值,可以傳入一個 JavaScript 物件字面量。記住,指令可以使用任意合法的 JavaScript 表示式:

<div v-demo=”{ color: ‘white’, text: ‘hello!’ }”></div>


Vue.directive('demo', function (value) {
console.log(value.color) // "white"
console.log(value.text) // "hello!"
})

字面修飾符

當指令使用了字面修飾符,它的值將按普通字串處理並傳遞給 update 方法。update 方法將只呼叫一次,因為普通字串不能響應資料變化。

<div v-demo.literal=”foo bar baz”>


Vue.directive('demo', function (value) {
console.log(value) // "foo bar baz"
})

元素指令

有時我們想以自定義元素的形式使用指令,而不是以特性的形式。這與 Angular 的 “E” 指令非常相似。元素指令可以看做是一個輕量元件。可以像下面這樣註冊一個自定義元素指令:


Vue.elementDirective('my-directive', {
// API 同普通指令
bind: function () {
// 操作 this.el...
}
})

不這樣寫:

<div v-my-directive></div>

這樣寫:

<my-directive></my-directive>

元素指令不能接受引數或表示式,但是它可以讀取元素的特性從而決定它的行為。

迥異於普通指令,元素指令是終結性的,這意味著,一旦 Vue 遇到一個元素指令,它將跳過該元素及其子元素——只有該元素指令本身可以操作該元素及其子元素。

高階選項

params

自定義指令可以接收一個 params 陣列,指定一個特性列表,Vue 編譯器將自動提取繫結元素的這些特性。例如:

<div v-example a=”hi”></div>


Vue.directive('example', {
params: ['a'],
bind: function () {
console.log(this.params.a) // -> "hi"
}
})

此 API 也支援動態屬性。this.params[key] 會自動保持更新。另外,可以指定一個回撥,在值變化時呼叫:

<div v-example v-bind:a=”someValue”></div>


Vue.directive('example', {
params: ['a'],
paramWatchers: {
a: function (val, oldVal) {
console.log('a changed!')
}
}
})

類似於 props,指令引數的名字在 JavaScript 中使用 camelCase 風格,在 HTML 中對應使用 kebab-case 風格。例如,假設在模板裡有一個引數 `disable-effect`,在 JavaScript 裡以 `disableEffect` 訪問它。

deep

如果自定義指令用在一個物件上,當物件內部屬性變化時要觸發 update,則在指令定義物件中指定 deep: true。

<div v-my-directive=”obj”></div>


Vue.directive('my-directive', {
deep: true,
update: function (obj) {
// 在 `obj` 的巢狀屬性變化時呼叫
}
})

twoWay

如果指令想向 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

傳入 acceptStatement:true 可以讓自定義指令接受內聯語句,就像 v-on 那樣:

<div v-my-directive=”a “></div>


Vue.directive('my-directive', {
acceptStatement: true,
update: function (fn) {
// 傳入值是一個函式
// 在呼叫它時將在所屬例項作用域內計算 "a  " 語句
}
})

明智地使用,因為通常你要在模板中避免副效應。

terminal

1.0.19  

Vue 通過遞迴遍歷 DOM 樹來編譯模組。但是當它遇到 terminal 指令時會停止遍歷這個元素的後代元素。這個指令將接管編譯這個元素及其後代元素的任務。v-if 和 v-for 都是 terminal 指令。

編寫自定義 terminal 指令是一個高階話題,需要較好的理解 Vue 的編譯流程,但這不是說不可能編寫自定義 terminal 指令。用 terminal: true 指定自定義 terminal 指令,可能還需要用 Vue.FragmentFactory 來編譯 partial。下面是一個自定義 terminal 指令,它編譯它的內容模板並將結果注入到頁面的另一個地方:


var FragmentFactory = Vue.FragmentFactory
var remove = Vue.util.remove
var createAnchor = Vue.util.createAnchor
Vue.directive('inject', {
terminal: true,
bind: function () {
var container = document.getElementById(this.arg)
this.anchor = createAnchor('v-inject')
container.appendChild(this.anchor)
remove(this.el)
var factory = new FragmentFactory(this.vm, this.el)
this.frag = factory.create(this._host, this._scope, this._frag)
this.frag.before(this.anchor)
},
unbind: function () {
this.frag.remove()
remove(this.anchor)
}
})

<div id="modal"></div>
...
<div v-inject:modal>
<h1>header</h1>
<p>body</p>
<p>footer</p>
</div>

如果你想編寫自定義 terminal 指令,建議你通讀內建 terminal 指令的原始碼,如 v-if 和 v-for,以便更好地瞭解 Vue 的內部機制。

priority

可以給指令指定一個優先順序。如果沒有指定,普通指令預設是 1000, terminal 指令預設是 2000。同一個元素上優先順序高的指令會比其它指令處理得早一些。優先順序一樣的指令按照它在元素特性列表中出現的順序依次處理,但是不能保證這個順序在不同的瀏覽器中是一致的。

可以在 API 中檢視內建指令的優先順序。另外,流程控制指令 v-if 和 v-for 在編譯過程中始終擁有最高的優先順序。

相關文章

前端開發 最新文章