Vue 学习笔记(十一):插槽 Slots

插槽 Slots

Slots 美[slɑːts]

插槽:简单理解就是组件内部留一个或多个的插槽位置,可供组件传对应的模板代码进去。插槽的出现,让组件变的更加灵活。

首先要明白插槽是使用在子组件中的,插槽是为了将父组件中的子组件模板数据正常显示。

2.6.0 为具名插槽和作用域插槽引入了一个新的统一的语法 ( v-slot 指令)。它取代了 slot 和 slot-scope 这两个目前已被废弃但未被移除且仍在文档中的 attribute。(旧代码仍有这种写法?遇到留意一下)

插槽内容 Slot Content

Vue implements a content distribution API inspired by the Web Components spec draft, using the <slot> element to serve as distribution outlets for content.
Vue 实现了一套内容分发的 API,这套 API 的设计灵感源自 Web Components 规范草案,将 <slot> 元素作为承载分发内容的出口。

插槽内可以包含任何模板代码,包括 HTML、其它的组件等。

编译作用域 Compilation Scope

父级模板里的所有内容都是在父级作用域中编译的;子模板里的所有内容都是在子作用域中编译的。

例如:当试图在一个插槽中使用数据时:

1
2
3
<navigation-link url="/profile">
Logged in as {{ user.name }}
</navigation-link>

该插槽跟模板的其它地方一样可以访问相同的实例 property (也就是相同的“作用域”),而不能访问 <navigation-link> 的作用域。如 url 是访问不到的:

1
2
3
4
5
6
7
8
<navigation-link url="/profile">
Clicking here will send you to: {{ url }}
<!--
这里的 `url` 会是 undefined,因为其 (指该插槽的) 内容是
_传递给_ <navigation-link> 的而不是
在 <navigation-link> 组件*内部*定义的。
-->
</navigation-link>

后备内容 Fallback Content

There are cases when it’s useful to specify fallback (i.e. default) content for a slot, to be rendered only when no content is provided. For example, in a <submit-button> component:
有时为一个插槽设置具体的后备 (也就是默认的) 内容是很有用的,它只会在没有提供内容的时候被渲染。例如在一个 <submit-button> 组件中:

1
2
3
<button type="submit">
<slot></slot>
</button>

将“Submit”作为后备内容,将它放在 <slot> 标签内,使 <button> 内默认渲染文本“Submit”:

1
2
3
<button type="submit">
<slot>Submit</slot>
</button>

当在一个父级组件中使用 <submit-button> 并且不提供任何插槽内容时:

1
<submit-button></submit-button>

后备内容“Submit”将会被渲染:

1
2
3
<button type="submit">
Submit
</button>

但是如果提供内容:

1
2
3
<submit-button>
Save
</submit-button>

则这个提供的内容将会被渲染从而取代后备内容:

1
2
3
<button type="submit">
Save
</button>

具名插槽 Named Slots

有时需要多个插槽。例如,对于一个带有如下模板的 <base-layout> 组件:

1
2
3
4
5
6
7
8
9
10
11
<div class="container">
<header>
<!-- 我们希望把页头放这里 -->
</header>
<main>
<!-- 我们希望把主要内容放这里 -->
</main>
<footer>
<!-- 我们希望把页脚放这里 -->
</footer>
</div>

对此,<slot> 元素有一个特殊的 attribute:name,可以用来定义额外的插槽:

1
2
3
4
5
6
7
8
9
10
11
<div class="container">
<header>
<slot name="header"></slot>
</header>
<main>
<slot></slot>
</main>
<footer>
<slot name="footer"></slot>
</footer>
</div>

一个不带 name<slot> 出口会带有隐含的名字“default”。

在向具名插槽提供内容的时候,可在一个 <template> 元素上使用 v-slot 指令,并以 v-slot 的参数的形式提供其名称:

1
2
3
4
5
6
7
8
9
10
11
12
<base-layout>
<template v-slot:header>
<h1>Here might be a page title</h1>
</template>
<p>A paragraph for the main content.</p>
<p>And another one.</p>
<template v-slot:footer>
<p>Here's some contact info</p>
</template>
</base-layout>

现在 <template> 元素中的所有内容都将会被传入相应的插槽。任何没有被包裹在带有 v-slot<template> 中的内容都会被视为默认插槽的内容。

然而,如果希望更明确一些,仍然可以在一个 <template> 中包裹默认插槽的内容:(However, you can still wrap default slot content in a <template> if you wish to be explicit)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<base-layout>
<template v-slot:header>
<h1>Here might be a page title</h1>
</template>
<template v-slot:default>
<p>A paragraph for the main content.</p>
<p>And another one.</p>
</template>
<template v-slot:footer>
<p>Here's some contact info</p>
</template>
</base-layout>

任何一种写法都会渲染出:

1
2
3
4
5
6
7
8
9
10
11
12
<div class="container">
<header>
<h1>Here might be a page title</h1>
</header>
<main>
<p>A paragraph for the main content.</p>
<p>And another one.</p>
</main>
<footer>
<p>Here's some contact info</p>
</footer>
</div>

注意 v-slot 只能添加在 <template> (只有一种例外情况:独占默认插槽的缩写)。

具名插槽其实就是在父组件中添加一个 slot='自定义名字' 的属性,
然后在子组件中的 <slot><slot> 里面添加 name='自定义名字' 即可
如果父组件中有一部分没有添加 slot 属性,则此处就是默认的插槽,在子组件中的 <slot></slot> 直接就是使用的父组件的默认插槽部分

作用域插槽 Scoped Slots

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

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

试图换掉备用内容,用名而非姓来显示。如下:

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

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

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

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

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

1
2
3
4
5
6
<current-user>
<!--下述slotProps自定义,可以是其它名字-->
<template v-slot:default="slotProps">
{{ slotProps.user.firstName }}
</template>
</current-user>

例子中将包含所有插槽 prop 的对象命名为 slotProps——可随意命名。

独占默认插槽的缩写语法

Abbreviated Syntax for Lone Default Slots

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

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

缩写,像假定未指明的内容对应默认插槽一样,不带参数的 v-slot 被假定对应默认插槽:

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

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

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

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

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

解构插槽 Prop

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

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

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

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

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

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

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

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

动态插槽名 Dynamic Slot Names

动态指令参数 也可以用在 v-slot 上,来定义动态的插槽名:

1
2
3
4
5
<base-layout>
<template v-slot:[dynamicSlotName]>
...
</template>
</base-layout>

具名插槽的缩写 Named Slots Shorthand

v-slot 也有缩写,即把参数之前的所有内容 (v-slot:) 替换为字符 #。例如 v-slot:header 可以被重写为 #header

1
2
3
4
5
6
7
8
9
10
11
12
<base-layout>
<template #header>
<h1>Here might be a page title</h1>
</template>
<p>A paragraph for the main content.</p>
<p>And another one.</p>
<template #footer>
<p>Here's some contact info</p>
</template>
</base-layout>

和其它指令一样v-onv-bind?),该缩写只在其有参数的时候才可用。以下是无效的:

1
2
3
4
<!-- 这样会触发一个警告 -->
<current-user #="{ user }">
{{ user.firstName }}
</current-user>

如果你希望使用缩写的话,你必须始终以明确插槽名取而代之:

1
2
3
<current-user #default="{ user }">
{{ user.firstName }}
</current-user>

其它示例

插槽 prop 允许我们将插槽转换为可复用的模板,这些模板可以基于输入的 prop 渲染出不同的内容。这在设计封装数据逻辑同时允许父级组件自定义部分布局的可复用组件时是最有用的。

例如,要实现一个 <todo-list> 组件,它是一个列表且包含布局和过滤逻辑:

1
2
3
4
5
6
7
8
<ul>
<li
v-for="todo in filteredTodos"
v-bind:key="todo.id"
>
{{ todo.text }}
</li>
</ul>

将每个 todo 作为父级组件的插槽,以此通过父级组件对其进行控制,然后将 todo 作为一个插槽 prop 进行绑定:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<ul>
<li
v-for="todo in filteredTodos"
v-bind:key="todo.id"
>
<!--
我们为每个 todo 准备了一个插槽,
将 `todo` 对象作为一个插槽的 prop 传入。
-->
<slot name="todo" v-bind:todo="todo">
<!-- 后备内容 -->
{{ todo.text }}
</slot>
</li>
</ul>

当使用 <todo-list> 组件时,可以为 todo 定义一个不一样的 <template> 作为替代方案,并且可以从子组件获取数据:

1
2
3
4
5
6
<todo-list v-bind:todos="todos">
<template v-slot:todo="{ todo }">
<span v-if="todo.isComplete"></span>
{{ todo.text }}
</template>
</todo-list>

这只是作用域插槽用武之地的冰山一角。想了解更多现实生活中的作用域插槽的用法,推荐浏览诸如 Vue Virtual ScrollerVue PromisedPortal Vue 等库。

更多参考