Vue基础之指令

✎printf("YT");

已于 2023-03-21 13:28:18 修改

阅读量53

点赞数

分类专栏： Vue 文章标签：前端前端框架 npm vue vue.js

于 2023-03-21 10:56:31 首次发布

本文链接：https://blog.csdn.net/qq_50564231/article/details/129661740

版权

Vue 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

提示：本文全长一万字左右，完整阅读大约需要花费33分钟。

前言

上一篇文章带领大家了解了Vue基础内容之一的生命周期，学习了生命周期三个阶段中最重要的8个生命周期函数，点击回顾Vue基础之生命周期。

这篇文章开始学习Vue基础的另外一个重要内容——指令。

一、Vue指令是什么？

指令（Directives）是 Vue 为开发者提供的模板语法，用于辅助开发者渲染页面的基本结构。按照指令使用方式的不同可分为：内置指令和自定义指令。

二、Vue内置指令

Vue.js 官网 API 中给出的内置指令共有15个，包括：v-text、v-html、v-show、v-if、v-else、v-else-if、v-for、v-on、v-bind、v-model、v-slot、v-pre、v-once、v-memo、v-cloak。

Vue 中的内置指令按照不同的用途又可以分为以下7类：

1.内容渲染指令

v-text

更新元素的文本内容。

期望的绑定值类型：string
详细信息
v-text 通过设置元素的 textContent 属性来工作，因此它将覆盖元素中所有现有的内容。如果你需要更新 textContent 的部分，应该使用 mustache interpolations 代替。

代码如下（示例）：

<!-- template -->

<span v-text="msg"></span>
<!-- 等同于 -->
<span>{{msg}}</span>

参考：模板语法 - 文本插值

v-html

更新元素的 innerHTML。

期望的绑定值类型：string
详细信息
v-html 的内容直接作为普通 HTML 插入—— Vue 模板语法是不会被解析的。如果你发现自己正打算用 v-html 来编写模板，不如重新想想怎么使用组件来代替。

安全说明：在你的站点上动态渲染任意的 HTML 是非常危险的，因为它很容易导致 XSS 攻击。请只对可信内容使用 HTML 插值，绝不要将用户提供的内容作为插值

在单文件组件，scoped 样式将不会作用于 v-html 里的内容，因为 HTML 内容不会被 Vue 的模板编译器解析。如果你想让 v-html 的内容也支持 scoped CSS，你可以使用 CSS modules 或使用一个额外的全局 <style> 元素，手动设置类似 BEM 的作用域策略。

代码如下（示例）：

<!-- template -->

<div v-html="html"></div>

参考：模板语法 - 原始 HTML

2.属性绑定指令

v-bind

动态的绑定一个或多个 attribute，也可以是组件的 prop。

缩写：: 或者 . (当使用 .prop 修饰符)
期望：any (带参数) | Object (不带参数)
参数：attrOrProp (可选的)
修饰符：
- .camel - 将短横线命名的 attribute 转变为驼峰式命名。
- .prop - 强制绑定为 DOM property。
- .attr - 强制绑定为 DOM attribute。

用途：
当用于绑定 class 或 style attribute，v-bind 支持额外的值类型如数组或对象。详见下方的指南链接。

在处理绑定时，Vue 默认会利用 in 操作符来检查该元素上是否定义了和绑定的 key 同名的 DOM property。如果存在同名的 property，则 Vue 会把作为 DOM property 赋值，而不是作为 attribute 设置。这个行为在大多数情况都符合期望的绑定值类型，但是你也可以显式用 .prop 和 .attr 修饰符来强制绑定方式。有时这是必要的，特别是在和自定义元素打交道时。

当用于组件 props 绑定时，所绑定的 props 必须在子组件中已被正确声明。

当不带参数使用时，可以用于绑定一个包含了多个 attribute 名称-绑定值对的对象。

代码如下（示例）：

<!-- template -->

<!-- 绑定 attribute -->
<img v-bind:src="imageSrc" />

<!-- 动态 attribute 名 -->
<button v-bind:[key]="value"></button>

<!-- 缩写 -->
<img :src="imageSrc" />

<!-- 缩写形式的动态 attribute 名 -->
<button :[key]="value"></button>

<!-- 内联字符串拼接 -->
<img :src="'/path/to/images/' + fileName" />

<!-- class 绑定 -->
<div :class="{ red: isRed }"></div>
<div :class="[classA, classB]"></div>
<div :class="[classA, { classB: isB, classC: isC }]"></div>

<!-- style 绑定 -->
<div :style="{ fontSize: size + 'px' }"></div>
<div :style="[styleObjectA, styleObjectB]"></div>

<!-- 绑定对象形式的 attribute -->
<div v-bind="{ id: someProp, 'other-attr': otherProp }"></div>

<!-- prop 绑定。“prop” 必须在子组件中已声明。 -->
<MyComponent :prop="someThing" />

<!-- 传递子父组件共有的 prop -->
<MyComponent v-bind="$props" />

<!-- XLink -->
<svg><a :xlink:special="foo"></a></svg>

.prop 修饰符也有专门的缩写，.：

<div :someProperty.prop="someObject"></div>

<!-- 等同于 -->
<div .someProperty="someObject"></div>

当在 DOM 内模板使用 .camel 修饰符，可以驼峰化 v-bind attribute 的名称，例如 SVG viewBox attribute：

<svg :view-box.camel="viewBox"></svg>

如果使用字符串模板或使用构建步骤预编译模板，则不需要 .camel。

3.事件绑定指令

v-on

给元素绑定事件监听器。

缩写：@
期望的绑定值类型：Function | Inline Statement | Object (不带参数)
参数：event (使用对象语法则为可选项)
修饰符：
- .stop - 调用 event.stopPropagation()。
- .prevent - 调用 event.preventDefault()。
- .capture - 在捕获模式添加事件监听器。
- .self - 只有事件从元素本身发出才触发处理函数。
- .{keyAlias} - 只在某些按键下触发处理函数。
- .once - 最多触发一次处理函数。
- .left - 只在鼠标左键事件触发处理函数。
- .right - 只在鼠标右键事件触发处理函数。
- .middle - 只在鼠标中键事件触发处理函数。
- .passive - 通过 { passive: true } 附加一个 DOM 事件。
详细信息
事件类型由参数来指定。表达式可以是一个方法名，一个内联声明，如果有修饰符则可省略。

当用于普通元素，只监听原生 DOM 事件。当用于自定义元素组件，则监听子组件触发的自定义事件。

当监听原生 DOM 事件时，方法接收原生事件作为唯一参数。如果使用内联声明，声明可以访问一个特殊的 $event 变量：v-on:click="handle('ok', $event)"。

v-on 还支持绑定不带参数的事件/监听器对的对象。请注意，当使用对象语法时，不支持任何修饰符。

代码如下（示例）：

<!-- template -->

<!-- 方法处理函数 -->
<button v-on:click="doThis"></button>

<!-- 动态事件 -->
<button v-on:[event]="doThis"></button>

<!-- 内联声明 -->
<button v-on:click="doThat('hello', $event)"></button>

<!-- 缩写 -->
<button @click="doThis"></button>

<!-- 使用缩写的动态事件 -->
<button @[event]="doThis"></button>

<!-- 停止传播 -->
<button @click.stop="doThis"></button>

<!-- 阻止默认事件 -->
<button @click.prevent="doThis"></button>

<!-- 不带表达式地阻止默认事件 -->
<form @submit.prevent></form>

<!-- 链式调用修饰符 -->
<button @click.stop.prevent="doThis"></button>

<!-- 按键用于 keyAlias 修饰符-->
<input @keyup.enter="onEnter" />

<!-- 点击事件将最多触发一次 -->
<button v-on:click.once="doThis"></button>

<!-- 对象语法 -->
<button v-on="{ mousedown: doThis, mouseup: doThat }"></button>

监听子组件的自定义事件 (当子组件的“my-event”事件被触发，处理函数将被调用)：

<!-- template -->

<MyComponent @my-event="handleThis" />

<!-- 内联声明 -->
<MyComponent @my-event="handleThis(123, $event)" />

4.双向绑定指令

v-model

在表单输入元素或组件上创建双向绑定。

期望的绑定值类型：根据表单输入元素或组件输出的值而变化
仅限：
- <input>
- <select>
- <textarea>
- components
修饰符：
- .lazy - 监听 change 事件而不是 input
- .number - 将输入的合法字符串转为数字
- .trim - 移除输入内容两端空格

5.条件渲染指令

v-show

基于表达式值的真假性，来改变元素的可见性。

期望的绑定值类型：any
详细信息
v-show 通过设置内联样式的 display CSS 属性来工作，当元素可见时将使用初始 display 值。当条件改变时，也会触发过渡效果。

v-if

基于表达式值的真假性，来条件性地渲染元素或者模板片段。

期望的绑定值类型：any
详细信息
当 v-if 元素被触发，元素及其所包含的指令/组件都会销毁和重构。如果初始条件是假，那么其内部的内容根本都不会被渲染。

可用于 <template> 表示仅包含文本或多个元素的条件块。

当条件改变时会触发过渡效果。

当同时使用时，v-if 比 v-for 优先级更高。我们并不推荐在一元素上同时使用这两个指令 — 查看列表渲染指南详情。

v-else

表示 v-if 或 v-if / v-else-if 链式调用的“else 块”。

无需传入表达式
详细信息
- 限定：上一个兄弟元素必须有 v-if 或 v-else-if。
- 可用于 <template> 表示仅包含文本或多个元素的条件块。

代码如下（示例）：

<!-- template -->

<div v-if="Math.random() > 0.5">
	Now you see me
</div>
<div v-else>
	Now you don't
</div>

v-else-if

表示 v-if 的“else if 块”。可以进行链式调用。

期望的绑定值类型：any
详细信息
- 限定：上一个兄弟元素必须有 v-if 或 v-else-if。
- 可用于 <template> 表示仅包含文本或多个元素的条件块。

代码如下（示例）：

<!-- template -->

<div v-if="type === 'A'">
  A
</div>
<div v-else-if="type === 'B'">
  B
</div>
<div v-else-if="type === 'C'">
  C
</div>
<div v-else>
  Not A/B/C
</div>

6.列表渲染指令

v-for

基于原始数据多次渲染元素或模板块。

期望的绑定值类型：Array | Object | number | string | Iterable
详细信息
指令值必须使用特殊语法 alias in expression 为正在迭代的元素提供一个别名：
```


<div v-for="item in items">
  {{ item.text }}
</div>
```
或者，你也可以为索引指定别名 (如果用在对象，则是键值)：
```


<div v-for="(item, index) in items"></div>
<div v-for="(value, key) in object"></div>
<div v-for="(value, name, index) in object"></div>
```
v-for 的默认方式是尝试就地更新元素而不移动它们。要强制其重新排序元素，你需要用特殊 attribute key 来提供一个排序提示：
```


<div v-for="item in items" :key="item.id">
  {{ item.text }}
</div>
```
v-for 也可以用于 Iterable Protocol 的实现，包括原生 Map 和 Set。

其它

v-slot

用于声明具名插槽或是期望接收 props 的作用域插槽。

缩写：#
期望的绑定值类型：能够合法在函数参数位置使用的 JavaScript 表达式。支持解构语法。绑定值是可选的——只有在给作用域插槽传递 props 才需要。
参数：插槽名 (可选，默认是 default)
仅限：
- <template>
- components (用于带有 prop 的单个默认插槽)

代码如下（示例）：

<!-- template -->

<!-- 具名插槽 -->
<BaseLayout>
  <template v-slot:header>
    Header content
  </template>

  <template v-slot:default>
    Default slot content
  </template>

  <template v-slot:footer>
    Footer content
  </template>
</BaseLayout>

<!-- 接收 prop 的具名插槽 -->
<InfiniteScroll>
  <template v-slot:item="slotProps">
    <div class="item">
      {{ slotProps.item.text }}
    </div>
  </template>
</InfiniteScroll>

<!-- 接收 prop 的默认插槽，并解构 -->
<Mouse v-slot="{ x, y }">
  Mouse position: {{ x }}, {{ y }}
</Mouse>

v-pre

跳过该元素及其所有子元素的编译。

无需传入
详细信息
元素内具有 v-pre，所有 Vue 模板语法都会被保留并按原样渲染。最常见的用例就是显示原始双大括号标签及内容。

代码如下（示例）：

<!-- template -->

<span v-pre>{{ this will not be compiled }}</span>

v-once

仅渲染元素和组件一次，并跳过之后的更新。

无需传入

详细信息
在随后的重新渲染，元素/组件及其所有子项将被当作静态内容并跳过渲染。这可以用来优化更新时的性能。

<!-- template -->

<!-- 单个元素 -->
<span v-once>This will never change: {{msg}}</span>
<!-- 带有子元素的元素 -->
<div v-once>
  <h1>comment</h1>
  <p>{{msg}}</p>
</div>
<!-- 组件 -->
<MyComponent v-once :comment="msg" />
<!-- `v-for` 指令 -->
<ul>
  <li v-for="i in list" v-once>{{i}}</li>
</ul>

从 3.2 起，你也可以搭配 v-memo 的无效条件来缓存部分模板。

v-memo

期望的绑定值类型：any[]
详细信息
缓存一个模板的子树。在元素和组件上都可以使用。为了实现缓存，该指令需要传入一个固定长度的依赖值数组进行比较。如果数组里的每个值都与最后一次的渲染相同，那么整个子树的更新将被跳过。举例来说：
```


<div v-memo="[valueA, valueB]">
  ...
</div>
```
当组件重新渲染，如果 valueA 和 valueB 都保持不变，这个 <div> 及其子项的所有更新都将被跳过。实际上，甚至虚拟 DOM 的 vnode 创建也将被跳过，因为缓存的子树副本可以被重新使用。

正确指定缓存数组很重要，否则应该生效的更新可能被跳过。v-memo 传入空依赖数组 (v-memo="[]") 将与 v-once 效果相同。

与 v-for 一起使用

v-memo 仅用于性能至上场景中的微小优化，应该很少需要。最常见的情况可能是有助于渲染海量 v-for 列表 (长度超过 1000 的情况)：
```


<div v-for="item in list" :key="item.id" v-memo="[item.id === selected]">
  <p>ID: {{ item.id }} - selected: {{ item.id === selected }}</p>
  <p>...more child nodes</p>
</div>
```
当组件的 selected 状态改变，默认会重新创建大量的 vnode，尽管绝大部分都跟之前是一模一样的。v-memo 用在这里本质上是在说“只有当该项的被选中状态改变时才需要更新”。这使得每个选中状态没有变的项能完全重用之前的 vnode 并跳过差异比较。注意这里 memo 依赖数组中并不需要包含 item.id，因为 Vue 也会根据 item 的 :key 进行判断。

警告：当搭配 v-for 使用 v-memo，确保两者都绑定在同一个元素上。v-memo 不能用在 v-for 内部。

v-memo 也能被用于在一些默认优化失败的边际情况下，手动避免子组件出现不需要的更新。但是一样的，开发者需要负责指定正确的依赖数组以免跳过必要的更新。

v-cloak

用于隐藏尚未完成编译的 DOM 模板。

无需传入
详细信息

该指令只在没有构建步骤的环境下需要使用。

当使用直接在 DOM 中书写的模板时，可能会出现一种叫做“未编译模板闪现”的情况：用户可能先看到的是还没编译完成的双大括号标签，直到挂载的组件将它们替换为实际渲染的内容。

v-cloak 会保留在所绑定的元素上，直到相关组件实例被挂载后才移除。配合像 [v-cloak] { display: none } 这样的 CSS 规则，它可以在组件编译完毕前隐藏原始模板。

代码如下（示例）：

/* css */

[v-cloak] {
  display: none;
}

<!-- template -->

<div v-cloak>
  {{ message }}
</div>

直到编译完成前，<div> 将不可见。

三、Vue自定义指令

介绍

除了 Vue 内置的一系列指令 (比如 v-model 或 v-show) 之外，Vue 还允许你注册自定义的指令 (Custom Directives)。

和组件类似，自定义指令在模板中使用前必须先注册。而根据注册方式的不同可分为局部注册和全局注册。

1.局部注册

在每个 Vue 组件中，可以在 directives 节点下声明私有自定义指令。示例代码如下：

// js

export default {
  directives: {
    // 为绑定到的 HTML 元素设置红色的文字
    bind(el) {
    	// 形参中的 el 是绑定了此指令的、原生的 DOM 对象
    	el.style.color = 'red'
    }
  }
}

在使用自定义指令时，需要加上 v- 前缀。示例代码如下：

<!-- template -->

<!-- 声明自定义指令时，指令的名字是 color -->
<!-- 使用自定义指令时，需要加上 v- 指令前缀 -->
<h1 v-color>App 组件</h1>

2.全局注册

全局共享的自定义指令需要通过“Vue.directive()”进行声明，示例代码如下：

// js

// 参数1：字符串，表示全局自定义指令的名字
// 参数2：对象，用来接收指令的参数值
Vue.directive('color', function(el, binding) {
	el.style.color = binding.value
})

指令钩子

一个指令的定义对象可以提供几种钩子函数 (都是可选的)：

// js

const myDirective = {
  // 在绑定元素的 attribute 前
  // 或事件监听器应用前调用
  created(el, binding, vnode, prevVnode) {
    // 下面会介绍各个参数的细节
  },
  // 在元素被插入到 DOM 前调用
  beforeMount(el, binding, vnode, prevVnode) {},
  // 在绑定元素的父组件
  // 及他自己的所有子节点都挂载完成后调用
  mounted(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件更新前调用
  beforeUpdate(el, binding, vnode, prevVnode) {},
  // 在绑定元素的父组件
  // 及他自己的所有子节点都更新后调用
  updated(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件卸载前调用
  beforeUnmount(el, binding, vnode, prevVnode) {},
  // 绑定元素的父组件卸载后调用
  unmounted(el, binding, vnode, prevVnode) {}
}

钩子参数

指令的钩子会传递以下几种参数：

el：指令绑定到的元素。这可以用于直接操作 DOM。
binding：一个对象，包含以下属性。
- value：传递给指令的值。例如在 v-my-directive="1 + 1" 中，值是 2。
- oldValue：之前的值，仅在 beforeUpdate 和 updated 中可用。无论值是否更改，它都可用。
- arg：传递给指令的参数 (如果有的话)。例如在 v-my-directive:foo 中，参数是 “foo”。
- modifiers：一个包含修饰符的对象 (如果有的话)。例如在 v-my-directive.foo.bar 中，修饰符对象是 { foo: true, bar: true }。
- instance：使用该指令的组件实例。
- dir：指令的定义对象。
vnode：代表绑定元素的底层 VNode。
prevNode：之前的渲染中代表指令所绑定元素的 VNode。仅在 beforeUpdate 和 updated 钩子中可用。

举例来说，像下面这样使用指令：
```


<div v-example:foo.bar="baz">
```
binding 参数会是一个这样的对象：
```
/* js */

{
  arg: 'foo',
  modifiers: { bar: true },
  value: /* `baz` 的值 */,
  oldValue: /* 上一次更新时 `baz` 的值 */
}
```
和内置指令类似，自定义指令的参数也可以是动态的。举例来说：
```


<div v-example:[arg]="value"></div>
```
这里指令的参数会基于组件的 arg 数据属性响应式地更新。

Note ：除了 el 外，其他参数都是只读的，不要更改它们。若你需要在不同的钩子间共享信息，推荐通过元素的 dataset attribute 实现。

简化形式

对于自定义指令来说，一个很常见的情况是仅仅需要在 mounted 和 updated 上实现相同的行为，除此之外并不需要其他钩子。这种情况下我们可以直接用一个函数来定义指令，如下所示：

<!-- template -->

<div v-color="color"></div>

// js

app.directive('color', (el, binding) => {
  // 这会在 `mounted` 和 `updated` 时都调用
  el.style.color = binding.value
})

总结

以上就是今天要讲的内容，本文仅仅简单介绍了Vue指令的使用方法，其中自定义指令部分也常作为前端面试问题，想要熟练使用还需要自己多花时间学习以及代码练习。

最后，如果本篇文章对正在阅读的您有所帮助或启发，请不要吝啬您的点赞收藏分享加评论，这样就可以让更多的人看到了。同时也欢迎留下您遇到的问题，让我们一起探讨学习，共同进步！

下一篇：Vue基础之监听器及计算属性

✎printf("YT");

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Vue基础之指令

上一篇文章带领大家了解了Vue基础内容之一的生命周期，学习了生命周期三个阶段中最重要的8个生命周期函数，点击回顾Vue基础之生命周期。这篇文章开始学习Vue基础的另外一个重要内容——指令。除了 Vue 内置的一系列指令 (比如 v-model 或 v-show) 之外，Vue 还允许你注册自定义的指令 (Custom Directives)。和组件类似，自定义指令在模板中使用前必须先注册。而根据注册方式的不同可分为局部注册和全局注册。
复制链接

扫一扫