作用域插槽

自 2.6.0 起有所更新。已废弃的使用 slot-scope 特性的语法在这里

有时让插槽内容能够访问子组件中才有的数据是很有用的。例如,设想一个带有如下模板的 <current-user> 组件:

  1. <span>
  2. <slot>{{ user.lastName }}</slot>
  3. </span>

我们想让它的后备内容显示用户的名,以取代正常情况下用户的姓,如下:

  1. <current-user>
  2. {{ user.firstName }}
  3. </current-user>

然而上述代码不会正常工作,因为只有 <current-user> 组件可以访问到 user 而我们提供的内容是在父级渲染的。

为了让 user 在父级的插槽内容中可用,我们可以将 user 作为 <slot> 元素的一个特性绑定上去:

  1. <span>
  2. <slot v-bind:user="user">
  3. {{ user.lastName }}
  4. </slot>
  5. </span>

绑定在 <slot> 元素上的特性被称为插槽 prop。现在在父级作用域中,我们可以给 v-slot 带一个值来定义我们提供的插槽 prop 的名字:

  1. <current-user>
  2. <template v-slot:default="slotProps">
  3. {{ slotProps.user.firstName }}
  4. </template>
  5. </current-user>

在这个例子中,我们选择将包含所有插槽 prop 的对象命名为 slotProps,但你也可以使用任意你喜欢的名字。

独占默认插槽的缩写语法

在上述情况下,当被提供的内容只有默认插槽时,组件的标签才可以被当作插槽的模板来使用。这样我们就可以把 v-slot 直接用在组件上:

  1. <current-user v-slot:default="slotProps">
  2. {{ slotProps.user.firstName }}
  3. </current-user>

这种写法还可以更简单。就像假定未指明的内容对应默认插槽一样,不带参数的 v-slot 被假定对应默认插槽:

  1. <current-user v-slot="slotProps">
  2. {{ slotProps.user.firstName }}
  3. </current-user>

注意默认插槽的缩写语法不能和具名插槽混用,因为它会导致作用域不明确:

  1. <!-- 无效,会导致警告 -->
  2. <current-user v-slot="slotProps">
  3. {{ slotProps.user.firstName }}
  4. <template v-slot:other="otherSlotProps">
  5. slotProps is NOT available here
  6. </template>
  7. </current-user>

只要出现多个插槽,请始终为所有的插槽使用完整的基于 <template> 的语法:

  1. <current-user>
  2. <template v-slot:default="slotProps">
  3. {{ slotProps.user.firstName }}
  4. </template>
  5. <template v-slot:other="otherSlotProps">
  6. ...
  7. </template>
  8. </current-user>

解构插槽 Prop

作用域插槽的内部工作原理是将你的插槽内容包括在一个传入单个参数的函数里:

  1. function (slotProps) {
  2. // 插槽内容
  3. }

这意味着 v-slot 的值实际上可以是任何能够作为函数定义中的参数的 JavaScript 表达式。所以在支持的环境下 (单文件组件现代浏览器),你也可以使用 ES2015 解构来传入具体的插槽 prop,如下:

  1. <current-user v-slot="{ user }">
  2. {{ user.firstName }}
  3. </current-user>

这样可以使模板更简洁,尤其是在该插槽提供了多个 prop 的时候。它同样开启了 prop 重命名等其它可能,例如将 user 重命名为 person

  1. <current-user v-slot="{ user: person }">
  2. {{ person.firstName }}
  3. </current-user>

你甚至可以定义后备内容,用于插槽 prop 是 undefined 的情形:

  1. <current-user v-slot="{ user = { firstName: 'Guest' } }">
  2. {{ user.firstName }}
  3. </current-user>