内置指令 ​

v-html ​

更新元素的 innerHTML。

• 期望的绑定值类型：string

• 详细信息

v-html 的内容直接作为普通 HTML 插入—— Vue.py 模板语法是不会被解析的。如果你发现自己正打算用 v-html 来编写模板，不如重新想想怎么使用组件来代替。

在单文件组件，scoped 样式将不会作用于 v-html 里的内容，因为 HTML 内容不会被 Vue.py 的模板编译器解析。

• 示例

  template

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

• 参考模板语法 - 原始 HTML

v-text ​

更新元素的文本内容。

• 期望的绑定值类型：string

• 详细信息

  v-text 通过设置元素的 textContent 属性来工作，因此它将覆盖元素中所有现有的内容。如果你需要更新 textContent 的部分，应该使用 mustache interpolations 代替。

• 示例

  template

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

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

v-show ​

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

• 期望的绑定值类型：any

• 详细信息

v-show 通过设置组件的 children 属性来工作，当组件可见时将组件添加到 children 属性，不可见时从 children 属性中移除，在这个过程中组件始终存在，元素及其所包含的指令/组件不会销毁和重构。

• 参考条件渲染 - v-show

v-if ​

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

• 期望的绑定值类型：any

• 详细信息

  当 v-if 元素被触发，元素及其所包含的指令/组件都会销毁和重构。如果初始条件是假，那么其内部的内容根本都不会被渲染。

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

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

• 参考条件渲染 - v-if

v-else ​

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

• 无需传入表达式

• 详细信息

  • 限定：上一个兄弟元素必须有 v-if 或 v-else-if。

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

• 示例

  template

  <div v-if="0.1 > 0.5">
    Now you see me
  </div>
  <div v-else>
    Now you don't
  </div>

• 参考条件渲染 - v-else

v-else-if ​

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

• 期望的绑定值类型：any

• 详细信息

  • 限定：上一个兄弟元素必须有 v-if 或 v-else-if。

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

• 示例

  template

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

• 参考条件渲染 - v-else-if

v-for ​

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

• 期望的绑定值类型：List | Dict | str | Iterable

• 详细信息

  指令值必须使用语法 alias in expression 为正在迭代的元素提供一个别名：

  template

  <div v-for="item in items">
    {{ item.text }}
  </div>

  或者，你也可以为索引指定别名 ：

  template

  <div v-for="(index, item) in items"></div>

• 参考
  • 列表渲染

v-on ​

给元素绑定事件监听器。

• 缩写：@

• 期望的绑定值类型：Function | Inline Statement | Object (不带参数)

• 参数：*args, **kwargs (和emit提交的payload一致)

• 详细信息

  事件类型由参数来指定。表达式可以是一个函数名，一个方法名。

• 当用于自定义元素组件（如ipywui的Button），则监听子组件触发的自定义事件。

  (暂不支持）当用于原生 html 元素（如span），只监听原生 DOM 事件。 当监听原生 DOM 事件时，方法接收原生事件作为唯一参数。

• 示例

  template

  <!-- 方法处理函数 -->
  <Button v-on:click="doThis"></Button>
  
  <!-- 动态事件(暂不支持）-->
  <Button v-on:[event]="doThis"></Button>
  
  <!-- 内联声明 -->
  <Button v-on:click="doThat('hello')"></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>
  
  <!-- 内联声明 -->
  <MyComponent @my_event="handleThis(123)"></MyComponent>

• 参考

  • 事件处理
  • 组件 - 自定义事件

v-bind ​

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

• 缩写：

  • : 或者 . (当使用 .prop 修饰符)

• 期望：any (带参数) | Object (不带参数)

• 参数：attrOrProp (可选的)

• 用途

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

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

• 示例

  template

  <!-- 绑定 attribute -->
  <img v-bind:src="imageSrc" />
  
  <!-- 动态 attribute 名 (暂不支持）-->
  <button v-bind:[key]="value"></button>
  
  <!-- 缩写 -->
  <img :src="imageSrc" />
  
  <!-- 缩写形式的动态 attribute 名，扩展为 :src="src" (暂不支持）-->
  <img :src />
  
  <!-- 动态 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>

• 参考
  • Class 与 Style 绑定
  • 组件 - Prop 传递细节

v-model ​

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

• 期望的绑定值类型：根据表单输入元素或组件输出的值而变化

• 仅限：

  • components

• 参考

  • 表单输入绑定
  • 组件事件 - 配合 v-model 使用

v-slot ​

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

• 缩写：#

• 期望的绑定值类型：能够合法在函数参数位置使用的 Python 表达式。

• 参数：插槽名 (可选，默认是 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.py 模板语法都会被保留并按原样渲染。最常见的用例就是显示原始双大括号标签及内容。

• 示例

  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

v-memo ​

• 期望的绑定值类型：any[]

• 详细信息

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

  template

  <div v-memo="[valueA, valueB]">
    ...
  </div>

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

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

  与 v-for 一起使用

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

  template

  <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.py 也会根据 item 的 :key 进行判断。

  警告

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

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

• 参考

  • v-once

v-cloak ​

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

• 无需传入

• 详细信息

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

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

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

• 示例

  css

  [v-cloak] {
    display: none;
  }

  template

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

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