Web Components 实践:使用 Stencil 构建自定义元素

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

Web Components 是一组技术规范,用于创建可重用、可组合的自定义 HTML 元素。这种技术可以将应用程序模块化,使其易于维护和重用,同时降低应用程序的复杂度。

Stencil 是一个基于 Web Components 规范的工具集,可以帮助我们轻松地构建、测试和部署自定义元素。

本文将介绍如何使用 Stencil 构建自定义元素,并提供实例代码和指导意义。

安装和创建项目

首先,在全局范围内安装 Stencil:

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

然后使用以下命令创建一个新项目:

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

这将引导您完成以下步骤:

  • 输入项目名称、描述和作者信息。
  • 选择 Web Components 的预设模板。Stencil 提供了一个基本模板、一个 Todo List 模板和一个 Ionic 模板。我们选择基本模板。
  • 安装所需的依赖项。Stencil 使用 TypeScript 和 Sass,因此会在项目中自动加入这些依赖项。

完成项目创建后,转到项目目录并运行以下命令:

--- -----

这将启动本地服务器,并在默认端口上(通常是 http://localhost:3333)显示您的应用程序。

项目的根目录结构如下所示:

--- -------------
--- ----
-   --- -----------
-   -   --- ---------
-   -   -   --- ------------
-   -   -   --- ------------
-   -   -   --- ---------
-   -   --- ---------
-   -   -   --- ------------
-   -   -   --- ------------
-   -   -   --- ---------
-   -   --- ------------
-   -   -   --- ---------------
-   -   -   --- ---------------
-   -   -   --- ---------
-   --- -------
-   -   --- -------
-   -   --- ----------
-   --- ----------
-   --- --------
--- -------
-   --- ---
--- -----------------
--- ------------
--- -------------
  • /src/components 目录包含所有自定义元素的代码。
  • /src/global 目录包含全局样式和基本 HTML 文件。
  • /src/assets 目录包含应用程序的静态资源和数据(例如图像和字体)。
  • stencil.config.ts 包含展开 Stencil 构建和部署的配置选项。

创建自定义元素

Stencil 的每个组件都是一个自定义元素(Custom Element),它继承了原生的 HTMLElement 和所有其他 DOM API。我们可以使用标准的 HTML,为每个元素添加属性和事件,就像使用内置的 html 元素一样。

/src/components 目录下创建一个新的目录(例如 my-component),并在该目录中创建一个新的 TypeScript 文件(例如 my-component.tsx)。

Stencil 允许使用 JSX 语法编写 HTML 模板。在 my-component.tsx 文件中,我们将创建一个简单的自定义元素,其中包含一个输入框和一个按钮,用于输入名称并发送问候语给用户:

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

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

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

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

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

在这个例子中,我们定义了一个 my-component 的自定义元素,并声明了两个属性 nameinputValuename 属性是一个字符串,它是通过 @Prop() 装饰器定义的。inputValue 属性是一个状态值,它是通过 @State() 装饰器定义的。

我们还定义了两个方法 handleSubmithandleInput,用于监听表单输入和按钮点击事件。在 render() 方法中,我们返回一个表单元素,并将事件绑定到相应的方法上。

这个例子演示了如何在 Stencil 中使用 JSX 和 TypeScript 编写自定义元素。现在我们需要将这个自定义元素添加到我们的应用程序中。

添加自定义元素到应用程序

要将 my-component 添加到应用程序中,在 /src/index.html 文件的 <body> 标签中插入 <my-component> 元素:

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

我们还需要在 index.ts 中引用自定义元素并将其添加到全局范围:

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

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

这样,我们的自定义元素就可以在应用程序中使用了。

现在启动本地服务器,打开 http://localhost:3333 并查看结果。您应该会看到一个表单,可以输入名称并点击按钮发送问候语。

给自定义元素添加样式

Stencil 允许为自定义元素添加样式,这些样式在使用 Shadow DOM 时可以隔离。

my-component 目录中,创建一个新的 Sass 文件(例如 my-component.scss),并在 my-component.tsx 文件中引用该文件。

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

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

现在,可以在 my-component.scss 中编写 Sass 样式代码:

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

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

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

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

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

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

这个例子演示了如何使用 Sass 为自定义元素添加样式。:host 选择器表示自定义元素本身的根节点。这样,我们可以在全局 CSS 中覆盖自定义元素的样式,而不会对其它节点产生任何影响。

测试自定义元素

Stencil 提供了一个集成测试框架,用于测试自定义元素的行为和功能。

创建一个新的目录 /src/components/my-component/test,并在该目录中创建一个新的测试文件 my-component.spec.tsx。在此文件中,我们将编写一个测试脚本,以确保自定义元素的输入和输出正常工作:

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

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

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

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

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

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

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

在这个例子中,我们使用 newSpecPage() 方法创建了一个实例,并模拟了一个 <my-component> 标签。我们测试了两种情况:

  • <my-component> 元素渲染时,根节点必须存在。
  • 当表单提交时,我们期望出现弹框,其中包含正确的问候语。

现在运行 npm test 命令,就可以看到测试结果了。

构建和部署自定义元素

Stencil 提供了多种选项,用于构建和部署自定义元素。

stencil.config.ts 中,您可以指定构建选项,例如要构建的目标平台、输出的目录和构建过程中的文件转换。

/public 目录中,您可以存放与应用程序相关的静态资源(例如图像和字体)和基本 HTML 模板。

要构建自定义元素的生产版本,请运行以下命令:

--- --- -----

这将在 /build 目录中生成一个打包好的文件。您可以将这些文件直接部署到 Web 服务器上,并使用自定义元素来构建更大的应用程序。

您还可以使用本地存储,通过自定义元素扩展现有应用程序的功能。由于自定义元素是标准的 HTML 元素,所以您可以将其添加到任何使用 HTML 的 Web 应用程序中。

结论

在本文中,我们介绍了如何使用 Stencil 构建自定义元素,并演示了如何在 Stencil 中使用 JSX 和 TypeScript 编写自定义元素。我们还介绍了如何测试自定义元素以及如何构建和部署它们。

Web Components 技术可以大大简化现代 Web 应用程序的开发、维护和部署。掌握 Web Components 技术可以使前端工程师更加轻松地开发可重用、可组合的自定义元素,提高应用程序的可维护性和可扩展性。我们鼓励您继续学习这种技术,以便在实际应用程序中使用 Web Components。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/671a0a0f9babaf620fa09c95


猜你喜欢

  • Angular 的模块和组件的生命周期

    在 Angular 中,模块和组件都具有生命周期,也就是在它们被创建、渲染和销毁的过程中,会触发一系列事件,开发者可以通过这些事件进行一些自定义的操作。本文将详细介绍 Angular 的模块和组件的生...

    18 天前
  • 利用 Web Components 技术优化前端性能的实践经验

    在大型 Web 应用中,前端性能是很重要的一方面。Web Components 技术可以帮助我们有效地优化前端性能。本文将介绍 Web Components 技术的基础知识及其在优化前端性能方面的实践...

    18 天前
  • Serverless 架构中的 API 设计技巧详解

    Serverless 架构越来越流行,它提供了一种新的构建和部署应用程序的方式,它将大部分服务管理和运维的工作交给了云服务商,使开发人员能够更快地开发和部署应用,保持高可扩展性和高可靠性。

    18 天前
  • React Native 中的生命周期方法指南

    React Native 是 Facebook 开源的一个框架,用于构建跨平台移动应用程序。React Native 采用了基于组件的设计模式,其组件可以定义一些生命周期方法来管理组件的状态和行为。

    18 天前
  • Express.js 应用程序的缓存控制和静态资源管理

    Express.js 是一个基于 Node.js 平台的极简、灵活的 Web 应用程序框架,在前端开发中得到广泛应用。本文将介绍在 Express.js 应用程序中如何进行缓存控制和静态资源管理。

    18 天前
  • React + Redux + React Router 集成总结

    React、Redux 和 React Router 是前端开发中非常流行的技术栈。React 作为一个高效的 UI 框架,Redux 作为状态管理库,而 React Router 则是使用 Reac...

    18 天前
  • PWA 的实际应用 —— 篇一

    近年来,PWA 技术越来越受到前端开发者的关注。PWA(Progressive Web App,渐进式 Web 应用)是一种利用 Web 技术开发的符合 PWA 标准的 Web 应用,具有类似原生 A...

    18 天前
  • Cypress 实现网页性能测试的最佳实践和优化技巧

    Cypress 实现网页性能测试的最佳实践和优化技巧 随着互联网的发展,网页性能已经成为了一个非常重要的指标。一些糟糕的网站性能会影响用户的体验,甚至会影响业务的运转。

    18 天前
  • 如何在 Koa2 中使用 WebSocket 实现实时聊天

    随着互联网技术的发展,实时通信在 web 应用中变得越来越重要。实时通信指用户之间的交流,比如聊天、游戏等,这些场景需要实时性较高且消息的传输不可靠,因此需要使用 WebSocket 技术来实现。

    18 天前
  • 如何使用 Hapi 和 Boom 实现 RESTful API 的错误处理

    RESTful API 经常会被开发者用来构建前端应用,因为它可以提供简单、可伸缩的接口,但是当出现错误时,必须要有很好的错误处理机制。在本文中,我们将学习如何使用 Hapi 和 Boom 库来实现 ...

    18 天前
  • Node.js 中的异常处理

    作为一名前端开发人员,在 Node.js 中,异常处理是一项十分重要的技能。Node.js 中的异常处理不仅可以帮助开发人员更好地监控应用程序的健康状况,同时也可以提高代码质量和开发效率。

    18 天前
  • 在 Node.js 中使用 TypeScript 的指南

    TypeScript 是一种强类型的 JavaScript 超集语言,它支持静态类型检查和更好的代码提示,并且能够将 TypeScript 编译成纯 JavaScript 代码以在浏览器中运行。

    18 天前
  • Node.js 中的 Promise 如何使用和处理错误

    简介 在 Node.js 中,Promise 是一种流行的异步编程机制,它可以帮助开发人员更有效地管理异步操作。Promise 提供了一种优雅的方式来组织和处理异步代码,消除了传统的回调嵌套问题。

    18 天前
  • 详解如何在网页中使用 LESS

    前言 LESS 是一种 CSS 预处理器,它能够让 CSS 代码更加优雅和易于管理。相比于原始 CSS,LESS 提供了一些更强大和灵活的语言特性,如变量,函数和嵌套规则等。

    18 天前
  • 在 Jest 中使用 DOM 测试

    什么是 Jest? Jest 是一个由 Facebook 开发的 JavaScript 测试框架,用于编写自动化测试和快照测试。它易于配置、易于使用,并集成了断言库、mock 库和代码覆盖率报告工具,...

    18 天前
  • 使用 GraphQL 创建可扩展的 WebHook 服务

    WebHook 服务是一种使网站、应用和服务之间自动同步的方法。使用 WebHook,当一个特定事件发生时,如发表文章或创建新用户,会自动向另一个应用程序发送 HTTP 请求,通常会包含 JSON 格...

    18 天前
  • ES11-null 性合并操作符和数字互操作性

    ES11-null 合并操作符和数字互操作性 在 ES11 中,一个令人兴奋的新特性是 null 合并操作符(??)。此操作符可以用来处理变量为 null 或 undefined 的情况。

    18 天前
  • 前端类技术文章:支持无障碍功能,让使用体验更优秀

    作为一名前端开发者,我们要始终关注用户体验,特别是那些使用辅助设备的用户。支持无障碍功能,可以让这部分用户也能方便地使用我们的应用程序,这对于用户体验是极其重要的。

    18 天前
  • React Native 中的 Fetch API 教程

    React Native 提供了一个名为 Fetch API 的网络请求服务,可用于获取和发送数据。Fetch API 具有良好的浏览器兼容性,并且是一种功能强大的基于 Promise 的 API,使...

    18 天前
  • 在 Koa 应用程序中使用 Mocha 和 Chai 进行端到端测试

    测试是任何应用程序开发人员的核心工作之一。端到端测试是测试应用程序的最终阶段,以确保应用程序按照预期工作。 在本文中,我将向您介绍如何使用 Mocha 和 Chai 测试框架来编写有效的端到端测试。

    18 天前

相关推荐

    暂无文章