0

0

ShadowDOM:每个 Web 开发人员都应该知道的被低估的宝石

聖光之護

聖光之護

发布时间:2025-01-02 22:41:30

|

680人浏览过

|

来源于php中文网

原创

深入理解Shadow DOM:构建独立Web组件的关键

在web开发中,创建可重用且不受外部环境影响的组件至关重要。shadow dom 正是为此而生的——一种将组件内部结构封装起来的技术,使其不受外部样式或脚本干扰。

这为何如此重要?它如何提升了我的产品LiveAPI的用户体验?让我们一探究竟!

什么是Shadow DOM?

ShadowDOM:每个 Web 开发人员都应该知道的被低估的宝石

Shadow DOM是一种Web标准,它在宿主元素内创建隔离的DOM片段(文档对象模型)。这种隔离确保影子树的内部结构和样式与页面其他部分相互独立。简单来说,它在DOM中创建了一个不受外部影响的微型DOM环境。

利用Shadow DOM,您可以定义组件的HTML、CSS和JavaScript,确保其不会与页面其他部分冲突。这使其成为构建可重用、模块化和可扩展组件的理想工具。

Shadow DOM如何解决LiveAPI的挑战

ShadowDOM:每个 Web 开发人员都应该知道的被低估的宝石

LiveAPI是我正在开发的一款产品,只需连接您的Git仓库即可快速生成API文档。

为了增强文档的交互性,我们开发了可嵌入的LiveAPI小部件。然而,这带来了挑战。

最初,在不同网站嵌入LiveAPI小部件时,我们遇到了问题。小部件需要执行API请求并以用户友好的方式显示结果。但如果没有Shadow DOM,小部件的表现会因与其他页面样式冲突而变得不稳定。

具体问题包括:

  • 样式冲突: 小部件的内部样式经常被页面全局样式覆盖,导致小部件在不同嵌入位置呈现差异,影响用户体验。
  • 脚本冲突: 小部件的JavaScript也可能与主机页面的脚本冲突,造成不可预测的行为,难以保持跨平台的一致性。

Shadow DOM解决了这些问题。通过将小部件封装在影子树中,我们确保:

  1. 样式独立: 小部件的内部CSS不受外部样式影响,保证其在任何位置都保持一致的外观。
  2. 脚本隔离: 小部件的JavaScript独立运行,降低了与其他脚本冲突的风险。

最终,我们为用户创建了无缝、一致的体验,无论小部件嵌入何处。

如何使用Shadow DOM:带代码示例的简明指南

让我们学习如何在项目中使用Shadow DOM。

1. 创建Shadow DOM

要使用Shadow DOM,您需要在现有元素上创建一个影子根。这可以通过调用attachShadow()方法实现。

一览AI绘图
一览AI绘图

一览AI绘图是一览科技推出的AIGC作图工具,用AI灵感助力,轻松创作高品质图片

下载

以下是如何为HTML元素创建影子根的示例:

this is the shadow host element.
// 步骤1:选择要附加影子根的元素
const host = document.getElementById('shadow-host');

// 步骤2:将影子根附加到宿主元素
const shadowRoot = host.attachShadow({ mode: 'open' });  // "open"允许访问Shadow DOM

// 步骤3:向影子根添加内容
shadowRoot.innerHTML = `
  
  

This content is inside the shadow DOM!

`;

在这个例子中:

  • attachShadow()方法在#shadow-host元素上创建影子根。
  • mode: 'open'选项表示影子DOM可以通过JavaScript访问(您也可以使用mode: 'closed'使其不可访问)。
  • 在影子根内部,我们定义了CSS和HTML,它们将被封装在影子DOM中。

2. 访问Shadow DOM

如果Shadow DOM的模式设置为open,则可以通过JavaScript访问影子树。以下是如何访问和修改Shadow DOM的示例:

const shadowHost = document.getElementById('shadow-host');
const shadowRoot = shadowHost.shadowRoot; // 访问影子根

// 修改Shadow DOM
const paragraph = shadowRoot.querySelector('p');
paragraph.textContent = "The shadow DOM content has been updated!";

在此代码中:

  • 我们使用shadowHost.shadowRoot访问影子根。
  • 然后,我们选择

    元素并更改其文本内容来修改Shadow DOM的内容。

3. Shadow DOM内部样式

让我们在Shadow DOM中设置组件样式,使其与网站其他部分隔离。

const shadowRoot = host.attachShadow({ mode: 'open' });

shadowRoot.innerHTML = `
  
  

This paragraph is styled inside the shadow DOM.

`;

此处,

的样式仅限于Shadow DOM,不会影响Shadow树之外的元素。这确保了组件无论页面其他部分的样式如何,都能按预期工作。

总结

总而言之,Shadow DOM 是构建独立于周围环境的健壮、可重用组件的关键技术。通过集成这项强大的技术,我们能够创建可在任何网站上稳定运行的LiveAPI小部件。

如果您对LiveAPI感兴趣,请访问hexmos.com/liveapi查看并试用文档生成功能。免费试用!

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

544

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

372

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

727

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

393

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

655

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

544

2023.09.20

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 0.7万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.7万人学习

CSS教程
CSS教程

共754课时 | 17.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号