Vuejs Directive

Posted on  by admin

您在浏览的是 v2.x 及更早版本的文档。v3.x 的文档在这里。 .

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

当页面加载时,该元素将获得焦点 (注意:autofocus 在移动版 Safari 上不工作)。事实上,只要你在打开这个页面后还没点击过任何内容,这个输入框就应当还是处于聚焦状态。现在让我们用指令来实现这个功能:. 如果想注册局部指令,组件中也接受一个 directives 的选项:. 然后你可以在模板中任何元素上使用新的 v-focus property,如下:. 一个指令定义对象可以提供如下几个钩子函数 (均为可选):. :被绑定元素插入父节点时调用 (仅保证父节点存在,但不一定已被插入文档中)。. :所在组件的 VNode 更新时调用,但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变,也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)。.

我们会在稍后讨论渲染函数时介绍更多 VNodes 的细节。. :指令所在组件的 VNode 及其子 VNode 全部更新后调用。. 接下来我们来看一下钩子函数的参数 (即 el、binding、vnode 和 oldVnode)。. :指令所绑定的元素,可以用来直接操作 DOM。. :一个对象,包含以下 property:. 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 }。. :Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。. oldVnode:上一个虚拟节点,仅在 update 和 componentUpdated 钩子中可用。.

除了 el 之外,其它参数都应该是只读的,切勿进行修改。如果需要在钩子之间共享数据,建议通过元素的 dataset 来进行。. 这是一个使用了这些 property 的自定义钩子样例:. 指令的参数可以是动态的。例如,在 v-mydirective:[argument]="value" 中,argument 参数可以根据组件实例数据进行更新!这使得自定义指令可以在应用中被灵活使用。.

这会把该元素固定在距离页面顶部 200 像素的位置。但如果场景是我们需要把元素固定在左侧而不是顶部又该怎么办呢?这时使用动态参数就可以非常方便地根据每个组件实例来进行更新。.

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

如果指令需要多个值,可以传入一个 JavaScript 对象字面量。记住,指令函数能够接受所有合法的 JavaScript 表达式。. 发现错误?想参与编辑?在 GitHub 上编辑此页! . support comment-directives in