使用 Custom Elements 构建通用的 Web Components

介绍

Web Components 是一种用于创建可重用的自定义元素的技术。Custom Elements 是 Web Components 的一部分，它使得我们能够创建新的 HTML 元素并在多个应用程序和页面上共享它们。

Custom Elements 的目的就是将 HTML 实现组件化，让组件的使用和封装变得更加简单、易于维护。在此过程中，我们需要关注一些细节问题，如命名规范、全局状态等，本文将会提供详细的指导。

本文将首先介绍 Custom Elements 的基础概念，然后根据需求情况，提供通用的 Web Components 的实现方案，最后讨论如何在 Vue、React 等框架中使用 Web Components。

基础概念

Custom Elements 是指通过编写 JavaScript 代码创建一组自定义标签，在 Web 应用中使用它们可以简化代码的编写和维护。一个组件由以下几部分组成:

  • 元素名：组件的元素名称，需要满足自定义元素规范，即包含一个短横线，如 my-element。
  • Shadow DOM 树：组件内部的 DOM 结构，没有被页面中其它部分的样式和脚本修改的能力。
  • Attributes 定义：定义组件的属性，主要用于传递数据和响应属性变化。
  • 生命周期钩子：用于自定义元素的属性更改、捆绑和卸载。
  • 方法和事件：组件内部的自定义方法和事件，用于与外部交互。

构建通用的 Web Components

在构建通用的 Web Components 时，我们需要注意如下几点：

命名规范

为了确保代码的可重用性，元素名称应该足够独特、具有语义和可读性。

例如，若我们要创建一个叫做“评分星级”的元素，则其名称应该为“star-rating”。

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

封装样式

为了避免 CSS 样式的全局污染，我们使用 Shadow DOM 树来封装样式。

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

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

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

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

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

构建属性

属性允许外部传入数据，并根据属性的变化执行相应的操作。

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

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

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

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

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

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

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

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

生命周期钩子

生命周期钩子允许我们重载元素在各个阶段的方法，例如构造函数、属性更改方法、元素卸载方法等。

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

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

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

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

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

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

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

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

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

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

方法和事件

我们使用 CustomEvent 来绑定自定义事件，方便我们与自定义元素进行交互。

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

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

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

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

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

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

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

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

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

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

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

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

在框架中使用 Web Components

在框架中使用 Web Components 主要有两个问题需要解决：

  • 如何在框架中加载 Web Components？
  • 如何从 Web Components 与框架进行交互？

Vue 中使用 Web Components

在 Vue 中使用 Web Components 需要先进行 Web Components 的引入。在 main.js 中，我们需要引入一个 Web Components 的 polyfill，然后再全局注册 Web Components。

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

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

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

上述代码中，我们引入 Web Components 的 polyfill，并全局注册 star-rating 组件。在组件中，我们可以使用 CustomEvent 来与 Vue 进行交互。

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

React 中使用 Web Components

在 React 中使用 Web Components 需要在 JSX 中引入 Web Components，并使用 ref 来获取 Web Components 的实例。然后我们可以使用 ref.current 操作 Web Components，并在 Web Components 中使用 CustomEvent 和 React 进行交互。

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

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

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

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

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

结论

Custom Elements 是 Web Components 的一部分，它可以让我们按需加载自定义的 HTML 元素。在构建通用的 Web Components 时，我们需要关注元素的命名规范、样式封装、属性定义、生命周期钩子、方法和事件。同时，在框架中使用 Web Components 时，我们需要解决 Web Components 的加载和 Web Components 与框架的通信问题。

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

阅读全文

猜你喜欢

  • 如何在 Android 应用程序中使用 Material Design 颜色？

    Material Design 是一个由 Google 推出的 UI 设计规范，旨在创造一种更加美观且可预测的用户体验，它强调直观性和一致性，并使用鲜艳的颜色和平面化的设计风格。

    2 个月前
  • ES7 之 Promise vs Observable

    在现代的前端开发中，异步编程是一种非常常见的需求。ES6 中引入的 Promise 已经在大多数场景中代替了传统的回调函数，但是在某些异步场景下，它仍然存在一些缺点和限制。

    2 个月前
  • Hapi 框架开发 Cookie Session 的使用教程

    在 Web 应用程序开发中， Cookie 和 Session 是常见的用户认证和状态管理方式。在 Hapi 框架中，提供了强大的插件支持，可以方便地实现 Cookie 和 Session 功能。

    2 个月前
  • 使用 CSS 实现无障碍体验的小窍门

    随着互联网的快速发展，越来越多的人开始通过电子设备使用网站和应用程序，但是对于那些视觉或听觉受限的人来说，在网站和应用程序上获取信息和内容可能会变得困难。为了让这些人也能轻松地访问网站和应用程序，我们...

    2 个月前
  • 在 GraphQL 中使用子查询连接数据

    GraphQL 是现代化的 API 查询语言，它提供了一种更加灵活和高效的方式来获取数据。与传统的 REST API 不同，GraphQL 允许客户端指定需要什么数据，从而减少了冗余数据的传输和解析，...

    2 个月前
  • 响应式设计中 Media Query 的调试技巧

    作为前端开发工程师，响应式设计是我们必须要学习掌握的技能之一。在实现响应式设计时，我们通常会使用 Media Query 技术来调整页面布局和样式，以适应不同设备的屏幕大小和分辨率。

    2 个月前
  • 使用 Enzyme 测试 React Hook

    React Hook 是 React16.8 新增的一个特性，利用它可以将组件中的状态逻辑抽出成可重用的函数。使用 Hook，我们可以在不编写类的情况下使用状态和其他 React 特性。

    2 个月前
  • 如何使用 Headless CMS 构建多语言网站

    在构建多语言网站的过程中，我们往往需要考虑到诸多的复杂性。其中最大的挑战就是如何有效地管理并展示不同语言的内容。传统的 CMS 系统通常将多语言功能集成在同一个数据库中，这种方法不仅难以维护，而且还会...

    2 个月前
  • 如何使用 Chai 对 JavaScript 数组进行测试

    简介 Chai 是一个流行的 JavaScript 测试库，可以帮助开发人员编写测试用例来检查代码是否按预期执行。本文将介绍如何使用 Chai 在前端项目中对 JavaScript 数组进行测试。

    2 个月前
  • 常见的 ES7 错误解决办法

    ES7 是 ECMAScript 7 的简称，它是 JavaScript 的一种版本，而且是目前最新的标准。在前端开发中，我们常常会遇到各种各样的错误，尤其是在使用 ES7 时，我们需要更加注意这些错...

    2 个月前
  • 如何使用 Deno 的测试功能？

    Deno 是一个现代化的 JavaScript/TypeScript 运行时，它被设计成安全的、稳定的、高效的。它是一个使用 V8 引擎和 Rust 语言编写的运行时，拥有类似 Node.js 的功能...

    2 个月前
  • React 基础：组件状态管理的最佳实践

    React 是一种构建用户界面的 JavaScript 库，由 Facebook 开发。React 可以让我们以声明式语法来描述 UI 的组成部分，且能够自动更新和优化组件。

    2 个月前
  • 无障碍设计的常见误解及如何避免

    什么是无障碍设计 无障碍设计（Accessible design）可以让人们以不同的能力水平，使用各种设备的方式，都能够轻松的访问和使用你的网站或应用程序。无障碍设计的目的是创建可访问性的产品，以便残...

    2 个月前
  • ES6 中解决 for…of 循环出现的错误

    对于前端开发者来说，JavaScript 是最重要的编程语言。ES6 是 JavaScript 的重要升级版本，它引入了许多新的语言特性和编程范式，使得编写 JavaScript 更加简单、高效。

    2 个月前
  • PM2 配置项详解及其实用技巧

    前言 PM2 是一个为 NodeJS 应用提供的生产环境进程管理工具，它具有自动重启、集群模式、负载均衡等功能，在使用 NodeJS 进行服务器开发时非常常用。本文将介绍 PM2 的常用配置项及实用技...

    2 个月前
  • NgRx + RxJS：如何处理全局状态管理

    在现代 Web 应用程序的开发中，状态管理是非常重要的一部分。随着应用程序的规模和复杂度的增加，管理数据的有效性和一致性变得越来越困难。在 Angular 应用程序中，可以使用 NgRx 和 RxJS...

    2 个月前
  • 将 Redux 和 React Router 集成到 React 应用中

    React 是一个流行的 JavaScript 库，广泛用于 Web 应用程序的开发。然而，对于大型应用程序，仅使用 React 来管理状态可能会变得麻烦和混乱。为此，Redux 作为一个状态管理工具...

    2 个月前
  • 在 Fastify 中使用 Mongoose 进行 MongoDB 操作

    简介 MongoDB 是一种流行的 NoSQL 数据库，很多 Node.js 项目都选择使用它。Mongoose 是一个 Node.js 的 ORM 框架，用于在 Node.js 中操作 MongoD...

    2 个月前
  • 你可能不知道的 Web Components 的具体应用场景和优势

    Web Components 作为一种全新的 Web 开发技术，可以让我们更加轻松地创建并重复使用可复合的 UI 组件。本文将介绍 Web Components 的应用场景和优势，并为读者提供实用的指...

    2 个月前
  • IIS 性能优化之提高 Web 服务器性能的方法

    在 Web 应用程序的开发过程中，良好的性能指标是非常重要的。对于一些大型的 Web 应用程序，它们的性能问题往往是最突出的。IIS 是 Windows 系统下的 Web 服务器，为了提高 Web 服...

    2 个月前

相关推荐

    暂无文章