vue指令

时间 2019-12-01

标签 vue 指令繁體版

原文原文链接

自定义指令

简介

除了核心功能默认内置的指令 (v-model 和 v-show)，Vue 也容许注册自定义指令。注意，在 Vue2.0 中，代码复用和抽象的主要形式是组件。然而，有的状况下，你仍然须要对普通 DOM 元素进行底层操做，这时候就会用到自定义指令。举个聚焦输入框的例子，以下：html

当页面加载时，该元素将得到焦点 (注意：autofocus 在移动版 Safari 上不工做)。事实上，只要你在打开这个页面后还没点击过任何内容，这个输入框就应当仍是处于聚焦状态。如今让咱们用指令来实现这个功能：vue

// 注册一个全局自定义指令 `v-focus`
Vue.directive('focus', {
 // 当被绑定的元素插入到 DOM 中时……
 inserted: function (el) {
 // 聚焦元素
 el.focus()
 }
})

若是想注册局部指令，组件中也接受一个 directives 的选项：node

directives: {
 focus: {
 // 指令的定义
 inserted: function (el) {
 el.focus()
 }
 }
}

而后你能够在模板中任何元素上使用新的 v-focus 属性，以下：express

<input v-focus>

钩子函数

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

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

接下来咱们来看一下钩子函数的参数 (即 el、binding、vnode 和 oldVnode)。

钩子函数参数

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

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 来进行。

这是一个使用了这些属性的自定义钩子样例：

<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) + '<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: '#hook-arguments-example',
 data: {
 message: 'hello!'
 }
})

name: "demo"
value: "hello!"
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

函数简写

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

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

对象字面量

若是指令须要多个值，能够传入一个 JavaScript 对象字面量。记住，指令函数可以接受全部合法的 JavaScript 表达式。

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

Vue.directive('demo', function (el, binding) {
 console.log(binding.value.color) // => "white"
 console.log(binding.value.text) // => "hello!"
})