如何使用 Web Components 构建可重用的 UI 组件库

阅读时长 10 分钟读完

前端开发中,UI 组件的复用是十分重要的。为了使组件复用更深入,我们可以使用 Web Components 技术。Web Components 是一组浏览器 API,可以创建自定义元素和组件。通过使用 Web Components,我们可以将组件打包为独立、可重用的模块,可以在不同的项目中进行共享。

本文将会介绍Web Components的基础概念,以及如何使用它们构建可重用的 UI 组件库。我们将会涉及到:

  • 基础知识: Shadow DOM
  • 组件的创建和使用
  • 组件的进阶用法: 模板和事件

Shadow DOM

Shadow DOM 是 Web Components 技术的核心概念之一。它是一个独立的 DOM 树,可以与主文档 DOM 树分离。这意味着 Shadow DOM 里的样式不会影响到主文档中其它部分的样式。

Shadow DOM 中的元素被包裹在“影子主机”的内部。影子主机是一个组件的 DOM 元素。当浏览器渲染组件时,它会将影子主机插入到主文档的 DOM 树中,然后再渲染影子主机内部的 DOM。使用 Shadow DOM,我们可以确保组件内部的样式和行为是被隔离的,而不会影响到其它部分。

组件的创建和使用

使用 Web Components,我们可以创建一个自定义元素,它可以包含我们定义的 HTML、CSS 和 JavaScript。这个元素可以随时在HTML中使用,并且可以用Javascript在其他任何地方进行构造。

下面,让我们来看一个简单的组件例子。我们将定义一个 my-button 的组件。它包含一个按钮,并且可以通过属性来指定文本。创建一个 my-button 组件有 3 个步骤:

  1. 定义 HTML,CSS 和 JavaScript
  2. 注册自定义元素
  3. 使用组件
-- -------------------- ---- -------
---- ---- ---- ---
--------- ------------------------
  -------
    ------ -
      ----------------- --------
      ------- -----
      ------ ------
      -------- ---- -----
      ----------- -------
      ---------------- -----
      -------- -------------
      ---------- -----
      ------- --- ----
      ------- --------
    -
  --------
  -----------------
-----------

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

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

首先,我们定义了一个名为 my-button-template 的 HTML <template>。它包含一个文本颜色为白色的绿色按钮。

然后,我们定义了一个 MyButton 类,它继承了 HTMLElement。当我们创建一个 my-button 的元素时,它的 constructor 就会被调用。

constructor中,我们首先创建 Shadow DOM,并通过调用 attachShadow({ mode: "open" })方法将其附加到自定义元素上。

接下来,我们获取了定义了模板的 my-button-template 元素。然后,我们使用 document.importNode() 方法将模板内容导入到 Shadow DOM 中并且将其作为子节点添加到 Shadow DOM。

最后,我们找到 Shadow DOM 中的 <button> 元素,并根据 text 属性设置按钮的文本。

最后,我们通过 window.customElements.define() 方法将 MyButton 类注册为 my-button 元素。

最后,我们使用HTML元素<my-button>来创建一个按钮,并指定了 text 属性。这将会创建一个新的 MyButton 实例,并将它插入到文档中。

组件的进阶用法:模板和事件

一个比较有意义的组件还应该支持更多的功能,例如可以动态更新内容、响应用户交互等。

下面,我们将介绍如何增强组件功能的两个技术:模板事件

模板

通过使用模板,我们可以动态更新组件的内容。首先,让我们向我们的 MyButton 组件中添加一个新属性 inputname,它表示 input 元素在组件内的 ID。

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

在该示例中,我们添加了一个 ID 为 input<input> 元素,可以在组件中通过该 ID 访问该元素。接下来,我们可以通过 JavaScript 来访问该元素,如下所示:

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

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

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

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

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

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

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

在该示例中,我们使用 clone.querySelector("#input") 查找 input 元素。我们然后可以向 input 元素中添加内容。

我们也添加了一个事件监听器,当用户单击按钮时,弹出一个 alert 消息。

此外,我们还定义了 observedAttributesattributeChangedCallback。这些回调允许我们追踪当组件的属性发生变化时的变化,并予以相应。

最后,通过使用 getset 方法,我们使 textinputname 属性成为“可设置”属性。

事件

通过事件,我们可以响应用户的交互行为。我们添加一个点击事件的监听器,打印一条信息来响应用户的单击事件。如下所示:

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

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

在该示例中,我们通过使用 button.addEventListener() 方法,添加了一个监听器。当用户点击按钮时,我们打印了一条消息。这种方式,我们可以为按钮添加更多的事件进行响应。

结论

在本文中,我们介绍了如何使用 Web Components 技术构建可重用的 UI 组件库。我们了解了 Web Components 的基础概念、组件的创建和使用,以及如何使用模板和事件增强组件功能。我们希望这篇文章可以帮助您开始使用 Web Components 技术,构建更易于维护和重用的前端组件库。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/66f2705ca44b36ee5765ef4f

纠错
反馈