Custom Elements 中 Shadow DOM 的应用及技巧分享

前言

Custom Elements 是 Web Components 标准的一部分，它允许开发者创建自定义元素，并把这些自定义元素组织成可重用的组件。Shadow DOM 是 Custom Elements 的一项关键特性，可以帮助开发者更好地封装组件内部的样式和结构，从而增强组件的可复用性和可维护性。

本文将介绍 Custom Elements 中如何使用 Shadow DOM，包括 Shadow DOM 的基础知识、使用 Shadow DOM 实现样式隔离和组件封装的方法，以及一些常用的 Shadow DOM 技巧和实践经验。

Shadow DOM 基础知识

Shadow DOM 是一种特殊的 DOM，它可以让开发者封装组件私有的样式和结构，避免组件内部的 DOM 节点被外部修改，从而增强组件的可复用性和可维护性。

在 Custom Elements 中，Shadow DOM 通常由两个部分组成：

  • Shadow Host：宿主元素，即 Custom Elements 实例自身；
  • Shadow Tree：Shadow DOM 树，也称为 Shadow Root，是组件的内部 DOM 树，包括自身的各种子元素和样式。

下面是一个通过 Shadow DOM 实现的简单 Custom Element，它包含了一个按钮和一个包含文字的容器：

---- -- ------ ------- - -------- ---
----- -------- ------- ----------- -
  ------------- -
    --------

    -- -- ------ --- ----
    ----- ---------- - ------------------- ----- ------ ---

    -- -- --- ------
    ----- --------- - ------------------------------
    ------------------- - ------------
    ------------------- - ------ -----

    ----- ----- - --------------------------------
    ----------------- - -
      ---------- -
        -------- -----
        ----------------- --------
        ------- --- ----- -----
        -------------- ----
        ------- --------
      -
    --

    -- - --- ------ ------ --- ---- -
    ------------------------------
    ----------------------------------

    -- --------
    ----------------------------------- -----------------------------
  -

  -- --------
  ------------- -
    ------------- ------ -------
  -
-

-- -- ------ -------
---------------------------------- ----------

通过 Shadow DOM，我们可以在自定义元素的内部定义私有的 DOM 结构和样式，从而避免组件内部的样式影响到全局，同时也可以防止外部组件直接访问和修改内部 DOM 结构。

Shadow DOM 样式隔离

Shadow DOM 的一个主要优势就是它能够为 Custom Elements 提供样式隔离的能力，这对于组件化开发来说非常有用。下面是一个示例代码，通过 Shadow DOM 实现了一个样式隔离的搜索框组件：

---- -- ------ ------- - -------- ---
----- -------- ------- ----------- -
  ------------- -
    --------

    -- -- ------ --- ----
    ----- ---------- - ------------------- ----- ------ ---

    -- -- --- ------
    ----- --------- - ------------------------------
    ------------------- - ------------

    ----- ----- - --------------------------------
    --------------- - --------
    ----------------- - ------------

    ----- ------ - ---------------------------------
    ---------------- - ---------
    ---------------- - -----

    ----- ----- - --------------------------------
    ----------------- - -
      ---------- -
        -------- -----
        ------------ -------
        ------ -----
        ---------- ------
        -------- -----
        ----------------- --------
        ------- --- ----- -----
        -------------- ----
      -

      ------ -
        ----- --
        ------- -----
        -------- -----
        ---------- -----
      -

      ------- -
        -------- --- -----
        ----------------- --------
        ------ -----
        ------- -----
        -------------- ----
        ------- --------
      -
    --

    -- - --- ------ ------ --- ---- -
    -----------------------------
    ------------------------------
    ------------------------------
    ----------------------------------

    -- --------
    -------------------------------- -----------------------------
  -

  -- ----------
  ------------- -
    ----- ------- - ----------------------------------------------
    ---------------- ---- -------------
  -
-

-- -- ------ -------
---------------------------------- ----------

上面的代码中，我们为搜索框组件定义了一个单独的 Shadow DOM Tree，内部包含了输入框和搜索按钮两个子元素，以及相应的样式。由于 Shadow DOM Tree 是独立于 Document 的私有 DOM 结构，所以搜索框的样式不会影响到外部的 CSS，同时也可以有效避免外部样式对组件的影响。

Shadow DOM 组件封装

除了样式隔离，Shadow DOM 还可以帮助开发者更好地进行组件封装。通过 Shadow DOM，我们可以在 Custom Element 内部封装一些 DOM 结构和逻辑，以便后续维护和复用。

下面是一个示例代码，通过 Shadow DOM 实现了一个组件化的日期选择器：

---- -- ------ ------- - ------------ ---
----- ------------ ------- ----------- -
  ------------- -
    --------

    -- -- ------ --- ----
    ----- ---------- - ------------------- ----- ------ ---

    -- -- --- ------
    ----- --------- - ------------------------------
    ------------------- - ------------

    ----- ----- - --------------------------------
    --------------- - --------
    ----------------- - ------- - ------

    ----- ------ - ---------------------------------
    ---------------- - ---------
    ---------------- - -----

    ----- ------ - ------------------------------
    ---------------- - ---------

    ----- ----- - --------------------------------
    ----------------- - -
      ---------- -
        -------- -----
        ------------ -------
        ------ -----
        ---------- ------
        -------- -----
        ----------------- --------
        ------- --- ----- -----
        -------------- ----
      -

      ------ -
        ----- --
        ------- -----
        -------- -----
        ---------- -----
      -

      ------- -
        -------- ----
        ---------- -----
        ----------------- ------------
        ------- -----
        ------- --------
      -

      ------- -
        --------- ---------
        ---- -----
        ----- --
        ------ -----
        ---------- ------
        -------- -----
        ----------------- -----
        ------- --- ----- -----
        ----------- - --- --- ------- -- -- ----
        -------------- ----
        -------- -----
        -------- ----
      -

      ------------ -
        -------- ------
      -
    --

    -- - --- ------ ------ --- ---- -
    -----------------------------
    ------------------------------
    ----------------------------------------
    ------------------------------
    ----------------------------------
    -------------------------------

    -- --------
    ------------------------------- ----------------------------------
    -------------------------------- -----------------------------------
  -

  -- ----------
  -------------- -
    ----- --------- - ------------------------------
    ------------------- - --------------

    ----- ----- - ------------------------------
    --------------- - --------
    --------------- - ------- ------ - ------

    ----- -------- - ------------------------------
    ------------------ - -----------

    -- -------------

    -----------------------------
    --------------------------------

    ------ ----------
  -

  -- ---------
  ------------------ -
    ---------------------------------------------------------------
  -

  -- ----------
  ------------------- -
    ------------------------------------------------------------------
  -
-

-- -- ------ -------
--------------------------------------- --------------

上面的代码中，我们通过 Shadow DOM 封装了一个日期选择器组件，内部包含了一个输入框和一个日历按钮，以及一个日期选择器面板。输入框的聚焦事件会显示日期选择器面板，日历按钮的点击事件则会切换日期选择器面板的显示状态。

通过 Shadow DOM，我们可以更好地封装自定义元素的内部逻辑和 DOM 结构，避免外部直接操作内部 DOM 结构，同时也可以提高组件的可复用性和可维护性。

Shadow DOM 技巧和经验

除了上面介绍的基础使用和组件封装方法，Shadow DOM 还有一些常用的技巧和实践经验可以分享：

Slot

Slot 是 Shadow DOM 中一个非常有用的功能，可以让 Custom Elements 动态插入内容到 Shadow Tree 中。使用 Slot 可以方便地构建更灵活的组件，让组件具有更好的可复用性。

---- -- ------ ------- - ------ ---
----- ------ ------- ----------- -
  ------------- -
    --------

    -- -- ------ --- ----
    ----- ---------- - ------------------- ----- ------ ---

    -- -- --- ------
    ----- --------- - ------------------------------
    ------------------- - ------------

    ----- ---- - -------------------------------
    --------- - ----------

    ----- ----- - --------------------------------
    ----------------- - -
      ---------- -
        -------- -----
        ----------------- -----
        ------- --- ----- -----
        -------------- ----
        ----------- - --- --- ------- -- -- ----
      -
    --

    -- - --- ------ ------ --- ---- -
    ----------------------------
    ------------------------------
    ----------------------------------
  -
-

-- -- ------ -------
-------------------------------- --------

上面的代码中，我们通过 Slot 实现了一个通用的卡片组件，可以接收任意内容插入到卡片的内部。使用方式非常简单：

---- -- ------ --------- ---
---------
  --- -------------------------
  -- --------------------------
----------

外部样式表

有时候我们需要在组件内引入外部的样式表，这时可以使用 Shadow DOM 提供的 <link> 标签实现样式的导入。

---- -- ------ ------- - -------- ---
----- -------- ------- ----------- -
  ------------- -
    --------

    -- -- ------ --- ----
    ----- ---------- - ------------------- ----- ------ ---

    -- -------
    ----- --------- - -------------------------------
    ------------- - -------------
    -------------- - -------------

    -- -- --- ------
    ----- --------- - ------------------------------
    ------------------- - ------------

    ----- ------ - ---------------------------------
    ---------------- - ---------
    ---------------- - --------------------------

    -- - --- ------ ------ --- ---- -
    ------------------------------
    ----------------------------------
    ----------------------------------
  -
-

-- -- ------ -------
---------------------------------- ----------

上面的代码中，我们通过 Shadow DOM 引入了 button.css 文件，并将 <link> 标签添加到 Shadow DOM Tree 中使样式生效。

Shadow DOM 中的事件

在 Custom Elements 中，Shadow DOM 中的事件处理和传递与普通 DOM 元素是有区别的。在 Shadow DOM Tree 中，事件处理和传递是局部的，只在 Shadow DOM 内部传递，不会像普通 DOM 元素那样冒泡到全局。

---- -- ------ ------- - ------ ---
----- ------ ------- ----------- -
  ------------- -
    --------

    -- -- ------ --- ----
    ----- ---------- - ------------------- ----- ------ ---

    -- -- --- ------
    ----- ---- - ----------------------------
    -------------- - -------
    --------- - ----
    -------------- - --------------------------

    ----- ----- - --------------------------------
    ----------------- - -
      ----- -
        ------ --------
        ---------------- -----
      -
    --

    -- - --- ------ ------ --- ---- -
    ------------------------------
    -----------------------------

    -- --------
    ------------------------------ -----------------------------
  -

  -- --------
  ------------------ -
    -----------------------
    ----------- -------- -------------------------------
  -
-

-- -- ------ -------
-------------------------------- --------

上面的代码中，我们通过 Shadow DOM 实现了一个链接组件 MyLink，并绑定了点击事件处理函数。在事件处理函数中，我们可以通过 event.preventDefault() 阻止默认行为，比如链接的跳转行为。同时注意，点击事件不会冒泡到全局，只在 Shadow DOM 内部传递。

总结

通过本文的介绍，我们了解了 Custom Elements 中如何使用 Shadow DOM，包括样式隔离、组件封装和常用技巧和实践经验等，这些都是实现更高效、可复用和可维护的 Web Components 的关键。

作为前端开发者，了解 Web Components 标准以及其基础技能已成为必备技能之一，希望本文的介绍可以对大家有所帮助。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/649bc44048841e9894885f97

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    2 个月前

相关推荐