你有好奇过这个问题吗,为什么只用video标签包裹着source标签,就可以完成一系列视频功能:播放/暂停按钮、进度条、视频时间显示、音量控制等等?既然 DOM 源码这么干净,你有想过实现这些组件的代码是从哪儿来的吗?

1. 简介

Shadow DOM它允许在文档(document)渲染时插入一棵DOM元素子树,但是这棵子树不在主DOM树中。

因此开发者可利用Shadow DOM 封装自己的 HTML 标签、CSS 样式和 JavaScript 代码。

看一个简单的video:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Shadow DOM</title>
</head>
<body>
<video controls autoplay name="media" width="500">
<source id="mp4" src="http://7ryl2t.com2.z0.glb.qiniucdn.com/572ffc37a2e5a.mp4" type="video/mp4">
</video>
</body>
</html>

页面完成了,在浏览器chrome中打开,然后打开 Chrome 的开发者工具,点击右上角的“Settings”按钮,勾选“Show user agent shadow DOM”。

Show user agent shadow DOM

浏览器截图:

Video Shadow DOM

#shadow-root称为影子根,可以看到它在video里面,换句话说,#shadow-root寄生在video上,所以video此时称为影子宿主。可以看到上图有两个#shadow-root,这是因为#shadow-root可以嵌套,形成节点树,即称为影子树(shadow trees)。影子树对其中的内容进行了封装,有选择性的进行渲染。这就意味着我们可以插入文本、重新安排内容、添加样式等等。如下所示:

影子树

2. 怎样创建Shadow DOM

使用createShadowRoot()来创建Shadow DOM,并赋值给一个变量,然后添加元素给变量即可。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Shadow DOM</title>
<style type="text/css">
.shadowroot_son {
color: #f00;
}
</style>
</head>
<body>
<div class="shadowhost">Hello, world!</div>
<script>
// 影子宿主(shadow host)
var shadowHost = document.querySelector('.shadowhost');
// 创建影子根(shadow root)
var shadowRoot = shadowHost.createShadowRoot();
// 影子根作为影子树的第一个节点,其他的节点比如p节点都是它的子节点。
shadowRoot.innerHTML = '<p class="shadowroot_son">夏天夏天悄悄过去留下小秘密!</p>';
</script>
</body>
</html>

浏览器截图:

创建Shadow DOM

有没有注意到.shadowroot_son的样式color: #f00;不生效?!那是因为影子宿主和影子根之间存在影子边界(shadow boundary),影子边界保证主 DOM写的 CSS 选择器和 JavaScript 代码都不会影响到Shadow DOM,当然也保护主文档不受 shadow DOM 样式的侵袭。

3. 想要渲染影子宿主里的内容,那该怎么玩?

需要完成此项任务,需要两个利器:<content><template>

3.1 <content>

通过 <content> 标签把来自主文档并添加到 shadow DOM 的内容被称为分布节点。

<content>的select属性告诉<content>标签有选择性的插入内容。select 属性使用 CSS 选择器来选取想要展示的内容,选择器包括类选择器、元素选择器等。

3.2 <template>

目前的模板HTML做法通常是在<script> 中嵌入模板HTML,让内部的HTML标签按照字符串处理的,从而使得内容不显示:

1
2
3
<script type="text/template">
// ...
</script>

<template>元素的出现旨在让HTML模板变得更加标准与规范。

<template>在使用前不会被渲染,不会执行加载等操作,也能够实现隐藏标签内容,而且位置任意性,可以在<head>中,也可以在<body>或者<frameset>中。

3.3 实例

通过以上对 <content><template>的简单了解,我们来通过一个实例加深理解:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>content&template</title>
</head>
<body>
<div class="shadowhost">
<em class="shadowhost_content1">唱歌</em>
<em class="shadowhost_content2">跳舞</em>
</div>
<!-- S 模板标签 template -->
<template class="template">
<h1><content select=".shadowhost_content1"></content><content select=".shadowhost_content2"></content>!</h1>
</template>
<!-- E 模板标签 template -->
<script>
var shadowHost = document.querySelector('.shadowhost');
var shadowRoot = shadowHost.createShadowRoot();
var template = document.querySelector('.template');
// template.content会返回一个文档片段,可以理解为另外一个document。
// 利用document.importNode获取节点,true表示深度克隆。
shadowRoot.appendChild(document.importNode(template.content, true));
</script>
</body>
</html>

浏览器截图:

content&template

我们来看一下下面三个属性的用途:

1
2
3
console.log(template.innerHTML); // 获取完整的HTML片段
console.log(template.content); // 返回一个文档片段#document-fragment
console.log(template.childNodes); // 返回[],说明childNodes无效

贪心插入点:如果把select=”.shadowhost_content1”改成select=””或者select=”*”,那么会有不一样的结果。因为贪心选择器放在了模板的第一个,他会将所有内容都抓取,不给其他select 选择器留一点内容。浏览器截图如下:

贪心插入点

4. 关于样式

4.1 宿主样式:host

在shadow DOM中利用:host定义宿主的样式,当然用户可以在主文档中覆盖这个样式。

:host 是伪类选择器(Pseudo Selector),:host或者 :host(*)是默认给所有的宿主添加样式,或者单独给一个宿主添加样式,即通过:host(x),x可以是宿主的标签或者类选择器等。

另外:host还可以配合:hover、:active等状态来设置样式,如:

1
2
3
:host(:hover) {
border: 2px solid #0ff;
}

4.2 ::shadow

原则上来说,影子边界保证主 DOM写的 CSS 选择器和 JavaScript 代码都不会影响到Shadow DOM。
但你可能会想打破影子边界的所谓保证,主文档能够给Shadow DOM添加一些样式,这时可以使用::shadow。

4.3 /deep/

::shadow 选择器的一个缺陷是他只能穿透一层影子边界,如果你在一个影子树中嵌套了多个影子树,那么使用 /deep/ 。

4.4 ::content

还记得什么叫分布节点吗?通过 <content> 标签把来自主文档并添加到 shadow DOM 的内容被称为分布节点。

分布节点的样式渲染需要用到 ::content。即使分布节点为em标签,直接写 em {} 不生效,应该写成::content > em {}。

4.5 实例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>::content&::shadow&/deep/</title>
<style type="text/css">
/* ::shadow */
/*.shadowhost::shadow h1 {
padding: 20px;
border: 1px solid #f00;
}*/
/* /deep/ */
.shadowhost /deep/ h1 {
padding: 20px;
border: 1px solid #000;
}
</style>
</head>
<body>
<div class="shadowhost">
<em class="shadowhost_content1">唱歌</em>
<em class="shadowhost_content2">跳舞</em>
</div>
<!-- S 模板标签 template -->
<template class="template">
<style>
/* 定义宿主样式:host */
:host {
color: #E85E5E;
}
/* 定义宿主hover状态下的样式 */
:host(:hover) {
color: #000;
}
/* 分布节点的样式渲染需要用到 ::content,直接写 em {} 不生效 */
::content > em {
padding: 10px;
color: #fff;
background: #FFCC00;
border-radius: 10px;
}
</style>
<h1><content select=".shadowhost_content1"></content><content select=".shadowhost_content2"></content>!</h1>
</template>
<!-- E 模板标签 template -->
<script>
var shadowHost = document.querySelector('.shadowhost');
var shadowRoot = shadowHost.createShadowRoot();
var template = document.querySelector('.template');
shadowRoot.appendChild(document.importNode(template.content, true));
</script>
</body>
</html>

浏览器截图如下:

::content&::shadow&/deep/

5. JavaScript

5.1 重定向

Shadow DOM 里的 JS 与传统的 JS 一个真正不同的点在于事件调度(event dispatching)。要记住的一点是:原来绑定在 shadow DOM 节点中的事件被重定向了,所以他们看起来像绑定在影子宿主上一样。

当你点击“shadow text”的输入框时控制台却输出了宿主元素(就是 #host)的 id 。这是因为影子节点上的事件必须重定向,否则这将破坏封装性。

分布节点来自原有 DOM 结构,没必要重定向。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>select</title>
</head>
<body>
<input id="normal-text" type="text" value="I'm normal text">
<div id="host">
<!-- “dustributed text”为分布节点,来自原有 DOM 结构,没必要重定向。 -->
<input id="distributed-text" type="text" value="I'm distributed text">
</div>
<template>
<div>
<input id="shadow-text" type="text" value="I'm shadow text">
</div>
<div>
<content></content>
</div>
</template>
<script>
var host = document.querySelector('#host');
var root = host.createShadowRoot();
var template = document.querySelector('template');
root.appendChild(document.importNode(template.content, true));
document.addEventListener('click', function(e) {
console.log(e.target.id + ' click!');
});
</script>
</body>
</html>

分别单击每个输入框,控制台打印截图如下:

事件重定向

5.2 被阻塞的事件(Blocked Events)

事件abort、 error、 select 、change 、load 、reset 、resize 、scroll 、selectstart不会进行重定向而是直接被干掉,因此事件不能冒泡到文档中,事件监听重定向至文档,因此无法监听到这一事件。

把上面的监听事件click改成select,即改成:

1
2
3
document.addEventListener('select', function(e) {
console.log(e.target.id + ' select!');
});

分别双击每个输入框,你会发现,shadow text的输入框没有打印,就是没有发生select事件。

被阻塞的事件

6. 兼容性

template兼容性

Shadow DOM兼容性

看上去只能在chrome中愉快地玩耍。

webcomponents.js使得Shadow DOM在非 native 支持的浏览器上实现。

7. 参考链接

A Guide to Web Components
Shadow DOM系列文章
HTML5 <template>标签元素简介

感谢您的阅读,本文由 凹凸实验室 版权所有。如若转载,请注明出处:凹凸实验室(https://aotu.io/notes/2016/06/24/Shadow-DOM/