Directive 指令

154 阅读2分钟

全局指令

使用 Vue.directive('x',directiveOptions) 可以生成一个全局的 v-x 指令,在任何组件都可以使用该指令 main.js

Vue.directive('x',{
	inserted(el){
  el.addEventListener('click',()=>console.log('x'))
  }
})

App.vue

<template>
	<div id="app">
		<p v-x>打印</p>
    </div>
</template>

效果:

局部指令

使用 directives 可以生成一个局部的 v-y 指令,该指令只能在声明的组件中使用

<template>
	<div id="app">
    	<button v-y>打印</button>
  	</div>
</template>

<script>
export default {
    name: "App",
    directives:{
      'y':{
        inserted(el){
      el.addEventListener('click',()=>console.log('y'))
    	}
      }
    }
};
</script>

效果:

Directive 指令中的钩子函数

  1. bind: 只调用一次,指令第一次绑定到元素时调用。在这里可以进行一次性的初始化设置
  2. inserted: 被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)
  3. update:所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)
  4. componentUpdated:指令所在组件的 VNode 及其子 VNode 全部更新后调用
  5. unbind:只调用一次,指令与元素解绑时调用。

钩子函数参数

指令钩子函数会被传入以下参数:

  • el:指令所绑定的元素,可以用来直接操作 DOM
  • binding:一个对象,包含以下 property:
    • name:指令名,不包括 v- 前缀
    • value:指令的绑定值,例如:v-my-directive="1 + 1" 中,绑定值为 2
    • oldValue:指令绑定的前一个值,仅在 updatecomponentUpdated 钩子中可用。无论值是否改变都可用
    • 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 编译生成的虚拟节点
  • oldVnode:上一个虚拟节点,仅在 updatecomponentUpdated 钩子中可用

App.vue

<template>
  <div id="app" v-demo:foo.a.b="message">
  </div>
</template>

main.js

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({
  render: h => h(App)
}).$mount("#app");

Console

name: "demo"
value: undefined
expression: "message"
argument: "foo"
modifiers: {"a":true,"b":true}
vnode keys: tag, data, children, text, elm, ns, context, fnContext, fnOptions, fnScopeId, key, componentOptions, componentInstance, parent, raw, isStatic, isRootInsert, isComment, isCloned, isOnce, asyncFactory, asyncMeta, isAsyncPlaceholder

指令的作用

  1. 主要用于原生DOM操作
  2. 减少重复,DOM操作较多或者操作复杂,可以封装为指令,减少DOM操作