前言
Custom Elements 是 Web Component 技术的一部分,这项技术能够让我们自定义 HTML 元素,实现可复用的组件。在这篇文章中,我们将会学习如何使用 Custom Elements 实现一个模态框组件。
模态框的基础知识
在开始编写我们的模态框组件之前,我们需要了解模态框的基本工作原理。模态框是一个覆盖在当前页面之上的 UI 元素,在模态框被展示时,用户只能和模态框交互。模态框一般会提供一个关闭按钮,当用户点击关闭按钮时,模态框会从页面中移除。
模态框可以用来展示警告、确认、提示、登录等功能,通常在用户进行一些重要操作时使用。同时,在移动设备上,在屏幕较小且需要弹出对话框请求用户响应时,模态框也是最常用的方式。
创建模态框组件
在这个例子中,我们将会创建一个 <app-modal> 组件,用于展示模态框。我们将会使用 Custom Elements、Shadow DOM 和 CSS Grid 布局来创建一个简单的模态框组件。
定义 <app-modal>
首先,我们需要定义 <app-modal>,这将是我们所创建的模态框组件的标记名称:
<app-modal></app-modal>
注册 <app-modal>
接下来,我们将使用 window.customElements.define()
将 <app-modal> 定义为一个自定义元素:
-- -------------------- ---- ------- ----- -------- ------- ----------- - ------------- - -------- -- --- - -- --- - ----------------------------------------- ----------
创建 Shadow DOM
我们需要为 <app-modal> 创建一个 Shadow DOM。Shadow DOM 允许我们创建完全封装的组件。只有 <app-modal> 内部的代码可以操作它的 Shadow DOM。我们可以使用 this.attachShadow()
方法来创建 Shadow DOM:
constructor() { super(); this.attachShadow({ mode: 'open' }); }
现在 <app-modal> 就有了一个空的 Shadow DOM 节点。接下来,我们需要在 Shadow DOM 中添加模态框的 HTML 和 CSS。
构建模态框
我们需要在 Shadow DOM 内部开发模态框所需的 HTML 和 CSS。我们可以使用 CSS Grid 固定模态框的顶部,然后使用 border-radius
、box-shadow
和其他 CSS 属性使模态框看起来和感觉像一个完整的元素。在完成样式表后,我们可以将 HTML 和 CSS 添加到 Shadow DOM 中:
-- -------------------- ---- ------- ------------- - -------- ------------------- ----- ------ --- ------------------------- - - ------- -- ---- -- ----- - --------- ------ ---- -- ----- -- ------ -- ------- -- -------- ----- ------------ ------- ----------------- ------- -- -- ----- - ------ - --------- --------- ----------- ---- ----------- ---- ------ ---- -------- ----- ------------------- ---- --- ----- ----------------- ------ -------------- ---- ----------- - --- ---- ------- -- -- ----- - ------------- - -------- ----- ------------ ------- -------- ----- -------------- --- ----- -------- ------------ ----- ---------- ------- - ----------- - -------- ----- ----------- ----- - ------------- - -------- ----- ---------------- --------- -------- ----- ----------- --- ----- -------- - -- ------- -- ------------------- - --------- -- - ----------------- - --------- -- - ------------------- - --------- -- - -- ------- -- ------------ - ----------------- ----- ------- --- ----- ----- ------ ----- -------- ------ ----- -------------- ---- ---------- ----- ------- -------- - ------------------ - ----------------- -------- ------------- -------- - ------------ - ----------------- -------- ------------- -------- ------ ----- - ------------------ - ----------------- -------- ------------- -------- - -------- ---- -------------- ----- --------------------- ---- ------------------- ----- ------------------- ------ ---- --------------------- ------- ------------------ ------------------ ------- ------------------------------- ------ ------ -- -
在上面的示例代码中,我们使用了 slot
在模态框组件中填充内容。slot
元素是一种特殊的容器,可以添加在组件内,用来接收外部传递进来的内容。在这个例子中,我们使用了三个不同的 slot
,分别用来添加模态框的标题、内容和底部按钮。
显示和关闭模态框
我们已经准备好了模态框组件。但是,我们还需要显示和关闭模态框。为了显示一个模态框,我们需要 在 <app-modal>
上添加 display: block
样式。为了关闭模态框,我们可以通过输入事件绑定,当用户按下 “ESC” 键或点击模态框之外的区域时,模态框会关闭。
-- -------------------- ---- ------- ------ - ------------------ - -------- - ------ - ------------------ - ------- - ------------------- - ------------------------------ ------- -- - -- ------------------------------------------ - ------------ - --- -------------------------------- ------- -- - -- ---------- --- --------- - ------------ - --- -
在 connectedCallback()
中,我们使用了 addEventListener()
绑定了两个事件,分别是点击 "关闭" 按钮和 "ESC" 键盘按键事件。同时,我们还定义了 show()
和 hide()
方法来控制模态框的显示和隐藏。
如何使用 <app-modal>
现在我们已经创建了一个功能完善的 <app-modal> 组件。在这个例子中,我们创建了一个 “登录” 模态框。以下是示例代码:
-- -------------------- ---- ------- ------- ------------------- ------------------------------------ ----------- --- --------------------- ----- ------------ ----- ------ -------------------------- ------ ----------- --------------- ------------- --------- ------ ----- ------ ------------------------- ------ --------------- --------------- ------------- --------- ------ ----- ------ --------------- --------------- -------------- ------ -------------------------- ------ ------- ------- ------------------------------- ------- ------------------ ------------------ ------------ -------- -------- ----------- - ----- ----- - ------------------------------------ ------------- - ---------
在这个示例代码中,我们使用了一个 “打开登录框” 的按钮,当点击按钮时,我们调用 openModal()
方法来展示登录模态框。同时,我们也为模态框组件添加了标题、表单内容和保存按钮。
总结
在这篇文章中,我们介绍了如何使用 Custom Elements 创建一个简单的模态框组件。我们使用了 Shadow DOM 和 CSS Grid 布局来构建我们的组件,并定义了一些基本方法来控制组件的显示和隐藏。 Custom Elements 提供了一种创建可复用组件的方法,它们可以在不同的项目和页面上使用,可以帮助开发者减少重复编码的时间,提高代码的可维护性。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6548bc3d7d4982a6eb2ff6a4