[Vue] 自定義指令

自定義指令

Vue是不建議大家直接操作DOM的,但是Vue 允許你注冊自定義指令,實質(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ù)的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)部,逗號分隔的多個從句將被綁定為多個指令實例。在下面的代碼中,指令會被創(chuàng)建和調(diào)用兩次:

<div v-demo="color: 'white', text: 'hello!'"></div>

如果想要用單個指令實例處理多個參數(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)簽的情形下,指令的行為如下:

  • 指令實例會有一個屬性,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ù)據(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 遇到一個元素指令,它將跳過對該元素和其子元素的編譯 - 即只有該元素指令本身可以操作該元素及其子元素。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Vue指令 Vue的指令以v-開頭,作用在HTML元素上,將指令綁定在元素上,給綁定的元素添加一些特殊行為。 例如...
    syd192閱讀 1,369評論 0 9
  • 除了內(nèi)置的指令外,Vue 也允許注冊自定義指令。 vue用Vue.directive(id,definition)...
    G_石頭閱讀 450評論 0 0
  • ??除了默認(rèn)設(shè)置的核心指令( v-model 和 v-show ),Vue 也允許注冊自定義指令。在Vue里,代碼...
    小小的開發(fā)人員閱讀 10,838評論 1 1
  • vue官方文檔中介紹了兩種自定義指令的方法:全局自定義和局部自定義。 全局自定義組件可以在main.js中直接注冊...
    Erric_Zhang閱讀 450評論 2 1
  • 最近經(jīng)常使用指令來實現(xiàn)一些功能,覺得甚是好用。然而卻遇到一個問題:v-if和我自定義指令在同一個標(biāo)簽里使用的時候,...
    墨子柚閱讀 1,785評論 0 0

友情鏈接更多精彩內(nèi)容