前言
有些知识点,比如说Web Components, 自己平时根本用不到,如果不刻意学习和了解,自己的知识体系就会产生盲区,可是每个人的知识盲区那么多,扫的过来嘛。对于这一点,我们要抱有积极的心态,少除一个就少一个。可是要扫除的技术盲区那么多,为什么要优先选择扫除它?这一点看个人偏好,没有标准答案。但有一个大方向是确定的,如果想在技术的道路上走得更远,就得不断清除阻碍自己前行的障碍拓宽自己的技术视野。废话不多说了,现在我们进入今天的主题。
Web Components简介
Web Components 是一组标准,用于创建可重用的、封装良好的自定义元素,能够与标准的 HTML 元素无缝集成。Web Components 使开发者能够定义自己的 HTML 标签,这些标签具有独立的样式和行为,从而增强了组件的可复用性和模块化程度。Web Components 由以下三项技术组成:
Custom Elements(自定义元素) :
- 允许开发者定义自己的 HTML 元素,并赋予这些元素自定义的行为。
- 通过 customElements.define 方法注册自定义元素。
- 自定义元素具有生命周期回调方法,例如 connectedCallback(挂载)、disconnectedCallback(卸载)、attributeChangedCallback(属性改变) 等。
Shadow DOM(影子 DOM) :
- 提供了一种封装组件内部 DOM 和样式的方法,使其与外部 DOM 和样式隔离。
- 使用 attachShadow 方法创建一个影子 DOM 根节点。
- 影子 DOM 内部的样式和结构不会影响外部的 DOM,反之亦然。
HTML Templates(HTML 模板) :
- 提供了一种定义可重用 HTML 结构的方法,这些结构在页面加载时不会立即呈现。
- 使用 标签定义模板内容。
- 模板内容在通过 JavaScript 克隆并插入到 DOM 中。
Web Components使用场景
Web Components技术是一组让开发者能够创建可重用的、封装良好的自定义HTML元素的标准。使开发者能够创建高度复用、独立、封装良好的组件,从而提高开发效率和代码质量。下面是一些典型的场景:
- 设计系统和组件库
许多公司和团队使用Web Components来构建设计系统和组件库。这些系统和库允许在不同项目中复用一致的UI组件,从而保持设计的一致性和开发的高效性。如Salesforce的Lightning Web Components、Ionic Framework中的Stencil。
- 跨框架组件共享
Web Components可以在不同的前端框架(如React、Angular、Vue)中无缝使用。这使得开发者能够创建独立于框架的组件,从而提高组件的复用性。在一个项目中使用React构建大部分页面,同时使用Web Components构建特定的独立组件,比如日期选择器或地图。
- 微前端架构
在微前端架构中,不同团队可以独立开发、部署和维护前端应用的不同部分。Web Components使得这些独立的部分可以以组件的形式集成到一个整体的应用中,而不会互相干扰。如一个电商网站的不同模块(如购物车、支付、用户评论)由不同团队开发,并以Web Components的形式集成。
- Web Widgets和插件
Web Components非常适合构建可以嵌入到任意网页中的小部件和插件,比如聊天窗口、表单验证、广告模块等。这些小部件通常需要高度的封装性和独立性,以避免与宿主页面的冲突。如第三方客服聊天窗口、嵌入式视频播放器。
- 数据可视化
创建数据可视化组件,如图表、地图、数据表等,这些组件可以独立于具体的应用环境,在不同的项目中重用。如使用D3.js或其他图表库创建的自定义元素,用于显示动态数据图表。
- 定制表单控件
构建复杂且可复用的表单控件,如日期选择器、颜色选择器、富文本编辑器等。这些控件可以被封装为自定义元素,便于在不同表单中复用。如一个自定义的富文本编辑器,可以用于博客系统、内容管理系统等多个场景。
- Web应用的组件化开发
在开发大型Web应用时,使用Web Components可以实现组件化开发,使得应用结构更清晰,组件更易于测试和维护。如在线文档编辑器中的各种工具栏和编辑器组件,每个都封装为独立的Web Component。
Web Components开发组件示例
模态对话框是Web应用中常见的UI组件,可以用于显示重要的消息、表单或确认对话框。我们通过用web components技术创建一个自定义的模态对话框组件,演示一下web components的使用方法。
1. 定义模板和自定义元素
将模板和自定义元素的定义放在一个JavaScript文件 my-modal.js中。
- 创建了一个模板 template,其中包含了模态对话框的结构和样式。 注意模板有三个插槽,可以让我们自定义模态框的标题,内容和底部区域。
- 定义了一个 MyModal 类,继承自 HTMLElement。
- 在 constructor 中使用 Shadow DOM 绑定模板内容。
- 实现了打开和关闭模态对话框的方法,以及处理相关的事件。
// my-modal.js
const template = document.createElement('template');
template.innerHTML = `
`;
class MyModal extends HTMLElement {
constructor() {
super();
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(template.content.cloneNode(true));
this.modal = this.shadowRoot.querySelector('.modal');
this.closeButton = this.shadowRoot.querySelector('.close-button');
this.footerCloseButton = this.shadowRoot.querySelector('#close-button');
this.close = this.close.bind(this);
}
connectedCallback() {
if (this.closeButton) {
this.closeButton.addEventListener('click', this.close);
}
if (this.footerCloseButton) {
this.footerCloseButton.addEventListener('click', this.close);
}
}
disconnectedCallback() {
if (this.closeButton) {
this.closeButton.removeEventListener('click', this.close);
}
if (this.footerCloseButton) {
this.footerCloseButton.removeEventListener('click', this.close);
}
}
open() {
this.modal.classList.add('open');
}
close() {
this.modal.classList.remove('open');
}
}
customElements.define('my-modal', MyModal);
2. 在 index.html 中引入模板和自定义元素
在HTML文件中通过 引入自定义元素的定义文件。
Modal Component Example
自定义头部
自定义内容区域
至此,我们实现了一个功能完整的模态对话框组件,并且能够在不同的页面中复用。
最后
使用web components开发了一个模态框之后,我们发现Web Components的一些不方便之处,比如说template的定义无法单独写在一个html文件中,必须用模版字符串包裹起来,不优雅。另外,我们习惯使用框架组件之后,发现Web Component和原生dom开发一样,不支持响应式数据,api相对繁琐等。这可能是web components不是特别热门的原因。可是有一种场景,特别适合用web components。就是一些很复杂的跨开发框架的组件,比如说日历组件,富文本编辑器,复杂的图标和表单等。总体说来,web components还是有用武之地的。有没有感觉,多了解一项技术,开发的时候就多了一分灵活性,所以说技多不压身。
手把手教你用Web Components开发一个跨框架的模态框
原文链接:
https://juejin.cn/post/7371319684842340363