Web Components 系列(六)—— 详解 Slots

简介: 熟悉 Vue 的同学应该都知道”插槽(slot)“的概念,通过使用插槽可以让页面内容的组织更加灵活。

18.png


前言


熟悉 Vue 的同学应该都知道”插槽(slot)“的概念,通过使用插槽可以让页面内容的组织更加灵活。


在 Web Components 体系中也有插槽的概念,今天我们就来具体了解一下 Slots,本文主要包括以下内容:


  • 为什么要用 Slots ?
  • Slots 的相关特性


Slots 的作用


我们首先来看一个模板元素:


<template>
    <div class = "header">MY CARD</div>
    <div class="details">
        My name is 编程三昧。
    </div>
</template>


既然是模板,那就意味着在很多地方都会使用到它,但是,这里会存在一个问题:所有使用这个模板的地方都将显示模板中的内容,即并不是所有人的名字都叫 ”编程三昧“。


在这种情况下,叫其他名字的人是没法使用这个模板的,显然,这就和使用模板的初衷相违背了,这个模板的使用范围太过狭小,不存在通用性。


想要使得这个模板具有通用性,其关键点在于 .details 中显示的内容是否具有通用性。


开动脑筋想一想,我们是不是可以将其中的”编程三昧“设为动态内容,谁使用这个模板,谁就传入自己的名字。恰好, Slots(插槽)就可以实现这种效果,具体如下:


<!--在模板中使用 slot 进行占位-->
<template id="cardTmp">
    <div class="header">MY CARD</div>
    <div class="details">
        My name is <slot name="userName">编程三昧</slot>。
    </div>
</template>
<!--在使用上面模板的自定义元素中给 slot 传值-->
<my-card>
    <span slot="userName">插槽传值</slot>
</my-card>
<my-card>
    <span slot="userName">web Components</slot>
</my-card>


其对应的 JS 代码如下:


class MyCard extends HTMLElement {
    constructor () {
        super();
        const template = document.getElementById('cardTmp');
        const templateContent = template.content;
        this.attachShadow({mode: 'open'}).appendChild(
            templateContent.cloneNode(true)
        );
    }
}
customElements.define('my-card', MyCard);


实现效果:


17.png


通过上面的例子,我们可以用一句话总结 Slots 的作用:Slots 的作用就是给模板元素传值,增强模板元素的灵活性和通用性。


Slots 的相关特性


对于 Slots 的相关特性,我通过问答的形式逐一解释。


Slots 的 name 属性有什么作用?


带有指定 name 的 Slots 被称为 ”具名插槽“,name 是 slot 的唯一标识。


在引入插槽内容的元素上需要使用与 Slots.name 值相同的 slot 属性。看下面的代码:


<template id="cardTmp">
    <div class="header">MY CARD</div>
    <div class="details">
        My name is <slot name="userAge">19</slot>。
    </div>
</template>
<my-card>
    <span slot="userName">编程三昧</slot>
</my-card>
<my-card>
    <span slot="userName">web Components</slot>
</my-card>
<script>
    class MyCard extends HTMLElement {
        constructor () {
            super();
            const template = document.getElementById('cardTmp');
            const templateContent = template.content;
            this.attachShadow({mode: 'open'}).appendChild(
                templateContent.cloneNode(true)
            );
        }
    }
    customElements.define('my-card', MyCard);
</script>


运行效果:


16.png


因为传入的 slot 属性值和 Slots 的 name 属性值对不上,所以 Slots 未被插入。


传值时的 slot 属性值必须和 Slots 的 name 属性值保持一致。


不给 Slots 传值会怎样?


将上面两个自定义元素 my-card 中的 span 元素去掉,不传任何值,即改成这样:


<my-card></my-card>


运行后的效果:


15.png


可以看到,如果不给 Slots 传值,那么 Slots 会显示它自己预设的内容


其实结合以上两点,还可以得出一个结论:如果有引用 Slots ,那只有对应 name 的 Slots 内容会被显示,其余的 Slots 皆不显示


正常 DOM 中可以使用 Slots 吗?


这里的”正常 DOM“ 是相对于 Shadow DOM 来说的,指的是页面所在的文档对象。

代码如下:


<slot name="userName">Slots 预设值</slot>
<div slot="userName">bcsm</div>


显示如下:


14.png


总结:正常 DOM 中使用 Slots,它会直接渲染在页面上,切不具备插槽效果


Slots 是不是必须用在 Templates 中?


我们前面看到的例子中,Slots 是在 Templates 中,那是不是意味着 Slots 必须要用在 Templates 中才能生效呢?


因为已经验证过在正常 DOM 中的 Slots 是无效的,所以我们在 Shadow DOM 中做个测试,代码如下:


<body>
    <h1>不在 Templates 中使用 Slots</h1>
    <div id="templ">
        <slot name="userName">这是 Slots 预设值</slot>
    </div>
    <my-paragraph>
        <span slot="userName">编程三昧</span>
    </my-paragraph>
    <script>
        class MyParagraph extends HTMLElement {
            constructor () {
                super();
                const template = document.getElementById('templ');
                this.attachShadow({mode: 'open'}).appendChild(
                    template.cloneNode(true)
                );
            }
        }
        customElements.define('my-paragraph', MyParagraph);
    </script>
</body>


显示效果如下:


13.png


从显示效果上可以看到,将包含 Slots 的正常 DOM 节点在追加到 Shadow DOM 后,Slots 显示传入的值,也就是说 Slots 是生效了的。


总结:Slots 在 Shadow DOM 中就可生效,并非一定要用在 Templates 中


一个自定义元素中可以使用多个同名 Slots 吗?


看代码:


<template id="cardTmp">
    <div class="header">MY CARD</div>
    <div class="details">
        My name is <slot name="userName">编程三昧</slot>。
    </div>
</template>
<my-card>
    <span slot="userName">插槽传值1</span>
    <span slot="userName">插槽传值2</span>
</my-card>
<script>
    class MyCard extends HTMLElement {
        constructor () {
            super();
            const template = document.getElementById('cardTmp');
            const templateContent = template.content;
            this.attachShadow({mode: 'open'}).appendChild(
                templateContent.cloneNode(true)
            );
        }
    }
    customElements.define('my-card', MyCard);
</script>


显示效果:


12.png


结论:一个 Slots 可以接收多个传入值,且都会解析显示出来


Slots 的传值元素必须是自定义元素的直接子元素吗?


上面的例子中,所有给 Slots 传值的元素都是自定义元素的子元素,那是不是非直接子元素不行呢?


代码如下:


<template id="cardTmp">
    <div class="header">MY CARD</div>
    <div class="details">
        My name is <slot name="userName">编程三昧</slot>。
    </div>
</template>
<my-card>
    <div>
        <span slot="userName">插槽传值1</span>
    </div>
</my-card>
<script>
    class MyCard extends HTMLElement {
        constructor () {
            super();
            const template = document.getElementById('cardTmp');
            const templateContent = template.content;
            this.attachShadow({mode: 'open'}).appendChild(
                templateContent.cloneNode(true)
            );
        }
    }
    customElements.define('my-card', MyCard);
</script>


运行效果(传值失效):


11.png


结论:给 Slots 传值的元素必须是自定义元素的直接子元素,否则传值失效


结束语


以上就是我对 Slots 相关知识的一个总结,目前能想到的就这些,肯定不全面,希望大家能够指正补充!


~ 本文完,感谢阅读!


学习有趣的知识,结识有趣的朋友,塑造有趣的灵魂!




相关文章
|
10月前
|
XML 开发框架 前端开发
浅谈 Fiori Fundamentals 和 SAP UI5 Web Components 的关系
浅谈 Fiori Fundamentals 和 SAP UI5 Web Components 的关系
|
13天前
|
JavaScript 前端开发 API
Web Components详解-HTML Templates
Web Components详解-HTML Templates
19 6
|
13天前
|
设计模式 JavaScript 前端开发
Web Components详解-组件通信
Web Components详解-组件通信
18 6
|
13天前
|
JavaScript 前端开发
Web Components详解-Shadow DOM样式控制
Web Components详解-Shadow DOM样式控制
14 3
|
13天前
|
JavaScript API 开发者
Web Components详解-Shadow DOM插槽
Web Components详解-Shadow DOM插槽
14 1
|
13天前
|
JavaScript 前端开发 开发者
Web Components详解-Shadow DOM基础
Web Components详解-Shadow DOM基础
12 1
|
13天前
|
JavaScript 前端开发 API
Web Components详解-Custom Elements
Web Components详解-Custom Elements
10 0
|
2月前
|
JavaScript 前端开发 架构师
Web Components:自定义元素与Shadow DOM的实践
Web Components是用于创建可重用自定义HTML元素的技术集合,包括Custom Elements、Shadow DOM、HTML Templates和Slots。通过Custom Elements定义新元素,利用Shadow DOM封装私有样式,&lt;slot&gt;元素允许插入内容。自定义元素支持事件处理和属性观察,可复用且样式隔离。它们遵循Web标准,兼容各前端框架,注重性能优化,如懒加载和Shadow DOM优化。
29 0
|
2月前
|
前端开发 JavaScript vr&ar
前端新技术探索:WebAssembly、Web Components与WebVR/AR
【4月更文挑战第12天】WebAssembly、Web Components和WebVR/AR正重塑Web应用的未来。WebAssembly允许C/C++等语言在Web上高效运行,提供接近原生的性能,如游戏引擎。Web Components通过Custom Elements和Shadow DOM实现可复用的自定义UI组件,提升模块化开发。WebVR/AR(现WebXR)则让VR/AR体验无需额外应用,直接在浏览器中实现。掌握这些技术对前端开发者至关重要。
38 3
|
7月前
|
Rust 前端开发 JavaScript
用Rust搭建React Server Components 的Web服务器(三)
用Rust搭建React Server Components 的Web服务器(三)