Vue directive

自定义指令 directive

详见官网：https://cn.vuejs.org/v2/guide/custom-directive.html

在 Vue2.0 中，代码复用和抽象的主要形式是组件。然而，有的情况下，你仍然需要对普通 DOM 元素进行底层操作，这时候就会用到自定义指令；

钩子函数

一个指令定义对象可以提供如下几个钩子函数 (均为可选)：

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

提示：与样式相关的操作均可在bind中执行；与js行为相关的操作，最好在inserted中执行

钩子函数参数

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

el：指令所绑定的元素，可以用来直接操作 DOM。
binding：一个对象，包含以下property：
- name：指令名，不包括 v- 前缀
- rawName：指令名，包括 v- 前缀、参数和修饰符。例如 v-my-directive:foo.aa 中，rawName为"v-my-directive:foo.aa"
- expression：字符串形式的指令表达式。例如 v-my-directive="1 + 1" 中，表达式为 "1 + 1"
- value：指令的绑定值，例如：v-my-directive="1 + 1" 中，绑定值为 2
- oldValue：指令绑定的前一个值，仅在 update 和 componentUpdated 钩子中可用。无论值是否改变都可用。
- 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 来进行。

动态指令参数

指令的参数可以是动态的。例如，在 v-mydirective:[argument]="value" 中，argument 参数可以根据组件实例数据进行更新！这使得自定义指令可以在应用中被灵活使用。

//动态参数必须指定到data中
export default {
  data() {
    return {
      argument: 'top'
    }
  }
}

对象字面量

如果指令需要多个值，可以传入一个 JavaScript 对象字面量。记住，指令函数能够接受所有合法的 JavaScript 表达式。

<div v-demo="{ color: 'white', text: content }"></div>

//支持data中动态的值
export default {
  data() {
    return {
      content: '中国人'
    }
  }
}

函数的简写

在很多时候，你可能想在 bind 和 update 时触发相同行为，而不关心其它的钩子。比如这样写：

//简写
Vue.directive('color-swatch', function (el, binding) {
  el.style.backgroundColor = binding.value
})

//完整写法
Vue.directive('color-switch', {
  bind: function(el, binding) {
    el.style.backgroundColor = binding.value
  },
  inserted: function(el, binding) {
    el.style.backgroundColor = binding.value
  },
  update: function(el, binding) {
    el.style.backgroundColor = binding.value
  }
})

私有指令

directives: {
  //非简写形式
  focus: {
    inserted: function(el, binding) {
      el.focus()
    }
  },
  //简写形式
  "change-color": function(el, binding) {
    el.style.color = binding.value
  }
}

共用指令

见过滤器共用指令

当全局自定义指令和私有自定义指令重名时，会采用私有自定义指令.

命名与使用规范

命名时，使用 - 连接，而不是驼峰命名法
命名时无需加 v- 而使用时，一定需要；例如：my-demo，使用时为 v-my-demo

最后编辑于：2020.09.22 10:13:18