Vue.js 自定义指令 - 学习 Vue.js 2 - 简单教程，简单编程

我们在应用中除了可以使用 Vue.js 自带的指令外 ( v-model 和 v-show 等)，还可以定义和注册自己指令

全局指令

注册自己的全局指令的语法格式如下

Vue.directive('[directive_name]', {
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})

然后就可以使用下面的方式调用自己的指令

<input v-[directive_name]>

中括号不是语法，是指令的名称

下面的范例注册一个全局指令 v-focus, 该指令的功能是在页面加载时，元素获得焦点

<div id="app">
    <p>页面载入时，input 元素自动获取焦点：</p>
    <input v-focus>
</div>
<footer>简单教程，简单编程<br/>Copyright © 简单教程</footer>
<script>
<script>
// 注册一个全局自定义指令 v-focus
Vue.directive('focus', {
  // 当绑定元素插入到 DOM 中。
  inserted: function (el) {
    // 聚焦元素
    el.focus()
  }
})
// 创建根范例
new Vue({
  el: '#app'
})
</script>

运行范例 »

局部指令

我们也可以在使用 directives 选项来注册局部指令，这样指令只能在这个实例中使用

<div id="app">
  <p>页面载入时，input 元素自动获取焦点：</p>
  <input v-focus>
</div>

<script>
// 创建根范例
new Vue({
  el: '#app',
  directives: {
    // 注册一个局部的自定义指令 v-focus
    focus: {
      // 指令的定义
      inserted: function (el) {
        // 聚焦元素
        el.focus()
      }
    }
  }
})
</script>

运行范例 »

钩子

我们在自定义指令时可以使用钩子函数

钩子函数

Vue.js 为指令定义函数提供了几个钩子函数（可选）：

函数	描述
bind	只调用一次，指令第一次绑定到元素时调用，用这个钩子函数可以定义一个在绑定时执行一次的初始化动作
inserted	被绑定元素插入父节点时调用（父节点存在即可调用，不必存在于 document 中）
update	被绑定元素所在的模板更新时调用，而不论绑定值是否变化通过比较更新前后的绑定值，可以忽略不必要的模板更新（详细的钩子函数参数见下）
componentUpdated	被绑定元素所在模板完成一次更新周期时调用
unbind	只调用一次，指令与元素解绑时调用

钩子函数参数

钩子函数的参数有

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

下面的范例演示如何使用这些参数

<div id="app"  v-twle:hello.a.b="message">
</div>

<script>
Vue.directive('twle', {
  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({
  el: '#app',
  data: {
    message: '简单教程!'
  }
})
</script>

运行范例 »

忽略钩子函数

如果我们不需要任何钩子函数，我们可以简写函数，比如

Vue.directive('twle', function (el, binding) {
  // 设置指令的背景颜色
  el.style.backgroundColor = binding.value.color
})

指令函数中的表达式

指令函数可接受所有合法的 JavaScript 表达式

下面的范例传入了 JavaScript 对象

<div id="app">
    <div v-twle="{ color: 'green', text: '简单教程!' }"></div>
</div>

<script>
Vue.directive('twle', function (el, binding) {
    // 简写方式设置文本及背景颜色
    el.innerHTML = binding.value.text
    el.style.backgroundColor = binding.value.color
})
new Vue({
  el: '#app'
})
</script>

运行范例 »