指令 directive

约 1390 字大约 5 分钟

2025-03-13

在 Vue 中，指令是一种特殊的标签属性，用于在模板中声明性地将数据与 DOM 元素进行绑定或操作。指令以 "v-" 开头，后面跟着指令的名称。

一、常用的内置指令

v-model：用于在表单元素上实现双向数据绑定。它可以将表单元素的值与 Vue 实例中的数据属性进行关联。例如，可以使用 v-model 指令将输入框的值绑定到 Vue 实例的一个数据属性上。
v-for：用于循环渲染列表或对象。它允许将一个数组或对象的数据渲染成多个相同的元素。例如，可以使用 v-for 指令将一个数组中的每个元素渲染为一个列表项。
v-if/v-else/v-else-if：用于根据表达式的值对元素进行条件渲染。v-if 指令用于条件地显示或隐藏元素，v-else 和 v-else-if 则用于在前一个条件不满足时进行条件渲染。
v-bind：用于动态地绑定 HTML 属性。它可以将 Vue 实例中的数据属性绑定到 HTML 元素的属性上，从而实现动态的数据绑定。v-bind:objName='xxxx'可以简写为:objName="xxxx"
v-on：用于监听 DOM 事件。它可以将 Vue 实例中的方法绑定到 DOM 元素的事件上，从而实现响应用户的交互操作。v-on:changeData='onChange'可以简写为@changeData='onChange'

二、自定义指令

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

1、全局注册

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

2、局部注册

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

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

3、钩子函数

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

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

4、钩子函数参数

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

el：指令所绑定的元素，可以用来直接操作 DOM。
binding：一个对象，包含以下 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 }。
vnode：Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情。
oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

5、动态指令参数

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

例如你想要创建一个自定义指令，用来通过固定布局将元素固定在页面上。我们可以像这样创建一个通过指令值来更新竖直位置像素值的自定义指令：

<div id="baseexample">
  <p>Scroll down the page</p>
  <p v-pin="200">Stick me 200px from the top of the page</p>
</div>

Vue.directive("pin", {
  bind: function (el, binding, vnode) {
    el.style.position = "fixed";
    el.style.top = binding.value + "px";
  },
});

new Vue({
  el: "#baseexample",
});

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

<div id="dynamicexample">
  <h3>Scroll down inside this section ↓</h3>
  <p v-pin:[direction]="200">I am pinned onto the page at 200px to the left.</p>
</div>

Vue.directive("pin", {
  bind: function (el, binding, vnode) {
    el.style.position = "fixed";
    var s = binding.arg == "left" ? "left" : "top";
    el.style[s] = binding.value + "px";
  },
});

new Vue({
  el: "#dynamicexample",
  data: function () {
    return {
      direction: "left",
    };
  },
});

6、函数简写

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

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

7、对象字面量

<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!"
});

更新日志

2025/8/24 08:17

查看所有更新日志

e7112-1于 2025/8/24

核心语法

路由