自定义指令分为全局指令和局部指令。全局指令可在任意vue组件内生效,局部指令仅在注册了指令的组件内生效。

全局指令和局部指令写法几乎相同。全局指令是在main.js内使用Vue.directive注册,局部指令是在组件的directives选项写入。

下面介绍一下指令的具体用法。

指令,常用于封装一些涉及dom的公共功能,比如表单的自动获取焦点,列表的下拉收缩等。

一、指令的钩子函数

指令对象共有五个钩子函数:bind、inserted、update、componentUpdated、unbind。这些参数均可选。

  • bind:只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置。

  • inserted:被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。

  • update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。

  • componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用。

  • unbind:只调用一次,指令与元素解绑时调用

二、钩子函数的参数

  • el:指令所绑定的元素,可以用来直接操作 DOM 。
  • binding:一个对象,包含以下属性:
    • name:指令名,不包括 v- 前缀。
    • value:指令的绑定值,例如:v-my-directive="1 + 1" 中,绑定值为 2
    • oldValue:指令绑定的前一个值,仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
    • expression:字符串形式的指令表达式。例如 v-my-directive="1 + 1"中,表达式为 "1 + 1"
    • arg:传给指令的参数,可选。例如 v-my-directive:foo 中,参数为 "foo"
    • modifiers:一个包含修饰符的对象。例如:v-my-directive.foo.bar 中,修饰符对象为 { foo: true, bar: true }
  • vnode:Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
  • oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。

除了 el 之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行。

三、简单的案例

一个实现了点击展开、选中收缩的下拉框.

代码如下:

vue:

<template>
    <div>
        <span class="direct-val">{{inputVal}}</span>
        <ul class="direct-list direct-hide" v-toogleList>
            <li class="direct-item" v-for="(item) in directList" :key="item" @click="changeVal(item)">{{item}}</li>
        </ul>
    </div>
</template>
<script>
export default {
    data(){
        return{
            inputVal:'1',
            directList:[1,2,3,4,5,6,7,8]
        }
    },
    methods:{
        changeVal(val){
            this.inputVal=val;
        }
    }
}
</script>

directive.js:

function toogleClass(){
    let dom=this;
    let classList=[...dom.classList];
    if(classList.includes('direct-hide')){
        dom.classList.remove('direct-hide');
        dom.classList.add('direct-show');
    }else if(classList.includes('direct-show')){
        dom.classList.remove('direct-show');
        dom.classList.add('direct-hide');
    }
}
export default {
    inserted(el,binding){
        el.previousElementSibling.addEventListener('click',toogleClass.bind(el))
        el.addEventListener('click',toogleClass.bind(el))
        console.log(binding)
    },
    unbind(el){
        el.previousElementSibling.removeEventListener('click',toogleClass.bind(el))
        el.removeEventListener('click',toogleClass.bind(el))
    }
}

main.js:

import Vue from 'vue'
import App from './App'
import router from './router'
import direct from './directives/directive'
Vue.config.productionTip = false
Vue.directive('toogleList', direct)
/* eslint-disable no-new */
new Vue({
  el: '#app',
  router,
  components: { App },
  template: '<App/>'
})

输出的bind对象如图:

效果:

四、其他事项

vue的官方文档还介绍了其他关于自定义指令的内容。

以上就是vue中自定义指令的简单介绍。

Logo

前往低代码交流专区

更多推荐