Vue.directive

Vue.directive( id, [definition] )
参数:
{string} id
{Function | Object} [definition]

// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
  // 当被绑定的元素插入到 DOM 中时……
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})
Vue.directive('my-directive', {
  bind: function () {},
  inserted: function () {},
  update: function () {},
  componentUpdated: function () {},
  unbind: function () {}
})
Vue.directive('my-directive', function () {
  // 这里将会被 `bind` 和 `update` 调用
})
var myDirective = Vue.directive('my-directive')// getter,返回已注册的指令

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

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

  • 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 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
  • oldVnode:上一个虚拟节点,仅在 updatecomponentUpdated 钩子中可用。
<div id="hook-arguments-example" v-demo:foo.a.b="message"></div>
Vue.directive('demo', {
  bind: function (el, binding, vnode) {
    var s = JSON.stringify
    el.innerHTML =
      'name: '       + s(binding.name) + '
'
+ // demo 'value: ' + s(binding.value) + '
'
+ // hello! 'expression: ' + s(binding.expression) + '
'
+ // mesage 'argument: ' + s(binding.arg) + '
'
+ // foo 'modifiers: ' + s(binding.modifiers) + '
'
+// {a:true,b:true} 'vnode keys: ' + Object.keys(vnode).join(', ') } }) new Vue({ el: '#hook-arguments-example', data: { message: 'hello!' } })

在Vue.js中,指令(Directive)是一种特殊的指令语法,用于在模板中声明式地应用对DOM元素的行为。指令的实现原理如下:

解析与注册:
Vue在解析模板的过程中,会扫描模板中的指令,并将其转换成相应的模板渲染函数。指令可以被定义在全局、局部或内联模板中:

全局注册:通过Vue.directive方法全局注册指令,Vue会将其存储在自身的options.directives对象中。
局部注册:在某个组件的options.directives中注册指令,来实现只在该组件中使用的指令。
内联模板:在模板中直接定义指令。
指令钩子函数:
指令钩子函数是在指令所绑定的元素插入到 DOM 中后执行的函数,它与 Vue.js 侦听器 Watcher 是订阅者和观察者的一种模式。有五个指令钩子函数可以用来在元素生命周期的不同阶段执行操作:

bind:只调用一次,在指令绑定到元素上时执行,以此初始化一些属性等操作。
inserted:在元素插入到 DOM 中时执行。
update:在组件更新时执行,但是指令所在的组件被成功更新之前执行,可以用此钩子函数来避免不必要的 DOM 操作。
componentUpdated:在组件更新时执行,指令所在的组件被成功更新之后执行。
unbind:只调用一次,在指令从元素上解除绑定时执行,以此清除指令绑定的一些事件等操作。
定义指令函数
指令函数包括两个参数:一个是指令绑定的元素,一个是指令绑定的对象,通过对这两个参数的操作,实现指令的功能。指令中最常用的参数包括el,binding,vnode。

el,即元素本身;
binding,是一个对象,包含了一些指令相关的属性,例如指令的值、修饰符等;
vnode,是 Vue 编译生成的虚拟节点。
指令函数可以通过修改el元素的属性、添加删除DOM节点等来实现操作DOM元素的目的。

总的来说,指令是Vue中的一个重要机制,其通过Vue内部的响应式机制,实现了在模板中简洁地声明式使用指令,并对DOM元素进行操作。通过定义并绑定钩子函数以及指令函数,使得Vue的指令功能具有了丰富的扩展性。

你可能感兴趣的:(前端)