自定义 Web 组件的完全指南：使用 Custom Elements 创建可重用的元素

随着 Web 技术的发展，前端应用的复杂性不断增加，需要更加高效和可维护的方式来管理代码和 UI 组件。在这种情况下，自定义 Web 组件已成为一种流行的解决方案。

在本文中，我们将介绍如何使用 Custom Elements API 来创建可重用的 Web 组件。我们将深入探讨 Custom Elements 的特性、用法和最佳实践，并提供示例代码和指导意义。

Custom Elements 的基础概念

Custom Elements 是 Web Component 规范的一部分，它允许开发者自定义 HTML 元素，提供一种更加模块化和可扩展的方式来构建应用。Custom Elements API 定义了两个核心部分：定义和注册。

定义 Custom Element

定义 Custom Element 的方式很简单：继承 HTMLElement 和使用 window.customElements.define API 进行注册。比如，我们可以通过下面的代码定义一个名为 hello-world 的元素。

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

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

在这个示例中，我们定义了一个 HelloWorld 类，继承自 HTMLElement，然后使用 window.customElements.define API 进行注册，并将其名称设置为 "hello-world"。在元素被创建时，构造函数中的代码将会被执行，将 "Hello, World!" 添加为元素的内容。

注册 Custom Element

要注册 Custom Element，需要使用 window.customElements.define() 方法，并指定元素名称和元素构造函数。如果元素名称已被注册，将会抛出错误。

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

Custom Elements 的特性

在定义 Custom Element 之后，我们可以使用其提供的特性来定制化元素。Custom Element API 定义了如下属性：

  • extends：指定元素从哪种 DOM 元素扩展而来。可以使用 constructor.extends 属性或直接传入 extends 选项。
----- ----------- ------- ----------------- -
  ------------- -
    --------
  -
-

------------------------------------- ------------ - -------- -------- ---
  • observedAttributes：指定应该观察哪些属性的列表。在元素上使用 setAttribute() 或 removeAttribute() 方法修改时筛选指定属性的变化。
----- --------- ------- ----------- -
  ------------- -
    --------
  -

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

  ------------------------------ --------- --------- -
    ----------------------- ------- ------- ---- ----------- -- --------------
  -
-
  • connectedCallback：当元素首次连接到文档DOM树中触发钩子。典型用例为装载 Shadow DOM，注册事件监听器或设置计时器。
----- --------- ------- ----------- -
  ------------- -
    --------
  -

  ------------------- -
    -------------------- ----- -- --- ------
  -
-
  • disconnectedCallback：当元素从文档DOM树中移除时触发钩子。典型用例包括清除计时器，销毁引用或取消注册事件监听器。
----- --------- ------- ----------- -
  ------------- -
    --------
  -

  ---------------------- -
    -------------------- ------- ---- --- ------
  -
-
  • adoptedCallback：当元素被移动到不同的文档时触发钩子。典型用例包括克隆模版和重新初始化子组件。
----- --------- ------- ----------- -
  ------------- -
    --------
  -

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

自定义 Web 组件的最佳实践

创建自定义 Web 组件时，有一些最佳实践可供参考：

  • 包装原始元素：如果您计划扩展现有的 DOM 元素，可以使用 extends 属性将其包装在自定义元素中。这允许您继承现有的行为，并以更模块化的方式构建应用程序。您可以在自定义元素的构造函数中调用 super()，以确保父类功能得到继承。例如：
----- ----------- ------- ----------------- -
  ------------- -
    --------
    -------------------------- - -------
  -
-

------------------------------------- ------------ - -------- -------- ---
  • 使用 Shadow DOM：Shadow DOM 为自定义元素提供了一种隔绝样式和元素的新方式。它允许您为自定义元素创建一个私有 DOM，其中的样式和事件不会泄漏到全局作用域。在您的自定义元素中使用 Shadow DOM 时，可以使用 :host 伪类样式访问自定义元素本身，而不是元素中的任何子元素。例如：
----- ---------- ------- ----------- -
  ------------- -
    --------
    ------------------- ----- ------ ---
    ------------------------- - -
      -------
        ----- - ------ ---- -
      --------
      ------------ -------------
    --
  -
-

------------------------------------ ------------
  • 使用模板：模板提供一种将标记和 JavaScript 分离的方式，使应用程序更易于维护。将您的模板添加到自定义元素的 shadow DOM 中，以便您可以同时更新组件的样式和结构。例如：
----- -------- - -----------------------------------
------------------ - -
  -------
    ----- - ------ ---- -
  --------
  ------------ -------------
--

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

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

自定义 Web 组件的示例代码

在下面的代码片段中，我们将结合前文介绍的 API 和最佳实践创建一个自定义 Web 组件，该组件可以在鼠标悬停时显示一条提示文本。我们将使用外部系统图标作为自定义元素的子元素，并使用 Shadow DOM 在元素中包装样式和行为。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

总结

Custom Elements API 为开发者提供了一种创建可重用的 Web 组件的方式。本文介绍了 Custom Elements 的特性、用法和最佳实践，并提供了示例代码和指导意义。如果您正在开发 Web 应用程序，并希望获得更好的模块化和可维护性，请考虑使用 Custom Elements。

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

阅读全文

猜你喜欢

  • 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 个月前

相关推荐