使用 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


猜你喜欢

  • Next.js 插入 cookie 造成的 Unhandled Promise Rejection 警告的问题解决办法

    Next.js 插入 cookie 造成的 Unhandled Promise Rejection 警告的问题解决办法 当使用 Next.js 时,我们可能需要在客户端添加 cookie。

    4 小时前
  • Performance Optimization:使用 Webpack SplitChunks 提高应用性能

    Performance Optimization:使用 Webpack SplitChunks 提高应用性能 当我们开发前端应用时,我们常常会面临应用过于庞大,加载时间过长,导致用户体验不良的问题。

    4 小时前
  • 如何处理未捕获的 Promise 错误?

    在前端开发中,Promise 是一种用于处理异步操作的技术,它可以帮助我们更好地掌控异步操作,提高代码的可读性和可维护性。但是,Promise 中可能存在未捕获的异常,如果不加以处理,就有可能导致代码...

    4 小时前
  • webpack 如何处理 ES6 转 ES5

    Webpack 是前端开发中常用的一种打包工具,它不仅能够将多个文件打包成一个文件,并且还可以实现对 JavaScript 的模块化、代码压缩等操作。在使用 Webpack 进行打包的过程中,我们时常...

    5 小时前
  • Jest 测试覆盖率不准确的解决方案

    在前端开发中,我们经常会使用 Jest 进行单元测试,其中测试覆盖率是一个非常重要的指标,可以帮助我们评估测试的质量和代码覆盖情况。然而,有时候测试覆盖率并不准确,这可能会导致我们误判测试质量和代码覆...

    5 小时前
  • Serverless 遇到超时错误怎么办?

    在 Serverless 应用程序中,处理大量请求时,可能会出现一个常见的错误——超时错误。这是由于 Lambda 函数无法在目标时间内完成并返回响应。 在这篇文章中,我们将探讨一些常见的 Serve...

    5 小时前
  • SPA 使用 Webpack 打包后本地空白问题解决

    单页应用(SPA)在前端开发中越来越流行。Webpack 是构建 SPA 的一种流行工具,它能够自动化地将代码打包成静态文件。虽然 Webpack 能够优化代码,但在本地调试时,经常会出现打包后的页面...

    5 小时前
  • ES7 新特性:Array.prototype.flatMap() 详解

    ES7 是 ECMAScript 的一个版本,也称 ES2016,它引入了一些新特性,其中之一是 Array.prototype.flatMap()。这是一个数组方法,可以扁平化嵌套数组,并映射处理每...

    6 小时前
  • 使用 Material Design 进行自定义图标设计教程

    作者:AI笔记本 Material Design 是 Google 推出的一种设计风格,计划覆盖 Android、Chrome OS、Web 和其它 Google 产品。

    6 小时前
  • Less 报错提示 “Parameter ‘color’ not found in mixin”

    在前端开发中,CSS 预处理器(Preprocessor) 是一个很常用的工具。而LESS是其中的一种,它让我们在 CSS 写作中拥有更多的选择,比如变量、函数、Mixin 等等。

    6 小时前
  • 解决 Redis 持久化过程中数据出错的问题

    什么是 Redis 持久化? Redis 是一个开源的高性能键值对存储数据库,在内存中存储数据。Redis 提供了两种持久化的方式,分别是 RDB 持久化和 AOF 持久化。

    6 小时前
  • 7 个 CSS Flexbox 布局问题的解决方案

    CSS 布局是 Web 前端开发中最重要的一部分之一,而 Flexbox(弹性盒布局)在 CSS3 中被引入,为前端开发人员提供了一种更加灵活的布局方式,尤其是对于响应式布局的支持。

    7 小时前
  • Web Components 如何处理异步渲染问题?

    Web Components 是一种让开发者可以创建可重用的自定义元素的技术。它使得开发者能够将自定义元素的所有属性和行为封装到一个单一容器中。但是,当涉及到异步渲染问题时,Web Component...

    7 小时前
  • 完整 ES10 和 ECMAScript 2019 功能列表

    简介 ECMAScript 是一种由 Ecma 国际组织标准化的脚本语言,它被广泛应用于 Web 开发中。随着技术的发展,ECMAScript 的版本也不断更新,新增了许多重要的功能。

    7 小时前
  • 如何快速配置自己的 ESLint 规则集

    ESLint 是一个开源的 JavaScript 代码检查工具,它可以用来检查代码是否符合制定的规则集。如果你是一名前端开发工程师,那么使用 ESLint 是十分必要的,因为它使代码检查更加简单快速,...

    7 小时前
  • 如何在 Node.js 中使用 GraphQL 编写 API

    什么是 GraphQL GraphQL 是一种新的 API 标准,由 Facebook 开发。相比于 RESTful API,GraphQL 具有更灵活、更可维护、更高效等优点。

    8 小时前
  • C#使用SSE接收服务器端的消息

    在Web开发中,服务器端经常需要推送实时信息给客户端,并实时展示更新。这时,传统的Ajax轮询和WebSocket均无法胜任了,这时候SSE(服务器发送事件)成为了一个不错的选择。

    8 小时前
  • Web 无障碍设计指南:如何为你的网站打造全盲用户可用的设计?

    什么是无障碍设计 无障碍设计是指为所有用户提供可访问的、易于理解的、易于操作的网站。 网络无障碍可以让那些使用屏幕阅读器、键盘导航、语音识别等辅助技术的用户,更好的浏览和使用网站。

    8 小时前
  • Chai 的实际应用:使用断言测试 RESTful API

    在前端开发过程中,测试是一个非常重要的步骤。随着应用程序变得越来越复杂,测试也变得越来越复杂。在进行 API 测试时,Chai 是一个非常有用的工具,可以帮助我们方便地撰写测试代码,以确保代码能够按照...

    8 小时前
  • Enzyme 测试教程:使用 mount() 与 shallow() 差异化测试 React 组件

    React 组件的测试是前端开发的重要一步,而 Enzyme 就是 React 的一个测试工具。Enzyme 允许开发者对 React 组件进行深度的测试,同时也可以对组件的渲染结果进行全面的检查。

    9 小时前