0

0

如何用Web Components封装跨框架的业务组件?

狼影

狼影

发布时间:2025-10-05 18:48:02

|

213人浏览过

|

来源于php中文网

原创

Web Components通过Custom Elements、Shadow DOM和HTML Templates实现跨框架复用。1. 使用customElements.define定义自定义标签,如user-info-card;2. Shadow DOM隔离样式与逻辑,避免全局污染;3. 通过observedAttributes监听属性变化,dispatchEvent抛出事件实现通信;4. 可打包为npm包,供React、Vue等项目直接引入使用,实现一次封装、多处运行。

如何用web components封装跨框架的业务组件?

Web Components 是一套浏览器原生支持的技术,能让你创建可复用、封装良好且不依赖框架的 UI 组件。用它封装跨框架的业务组件,核心在于利用其三大特性:自定义元素(Custom Elements)、影子 DOM(Shadow DOM)和 HTML 模板(HTML Templates)。这样封装的组件可以在 React、Vue、Angular 甚至纯 HTML 项目中直接使用。

1. 使用 Custom Elements 定义组件标签

通过 customElements.define() 注册一个自定义 HTML 标签,这是跨框架使用的入口。

例如,封装一个用户信息卡片:
class UserInfoCard extends HTMLElement {
  constructor() {
    super();
    this.attachShadow({ mode: 'open' });
  }

connectedCallback() { const name = this.getAttribute('name') || '未知'; const avatar = this.getAttribute('avatar');

this.shadowRoot.innerHTML = `
  zuojiankuohaophpcndiv class="card"youjiankuohaophpcn
    zuojiankuohaophpcnimg src="${avatar}" alt="头像" /youjiankuohaophpcn
    zuojiankuohaophpcnspanyoujiankuohaophpcn${name}zuojiankuohaophpcn/spanyoujiankuohaophpcn
  zuojiankuohaophpcn/divyoujiankuohaophpcn
`;

} }

customElements.define('user-info-card', UserInfoCard);

之后在任意框架中都可以直接写:

2. 利用 Shadow DOM 实现样式与逻辑隔离

影子 DOM 能防止外部 CSS 干扰组件内部结构,也能避免组件样式“泄漏”到全局,这对跨项目复用非常关键。

在上面的例子中,this.attachShadow({ mode: 'open' }) 创建了独立的作用域,组件内的样式不会影响页面其他部分。

你可以在 shadowRoot 中注入样式:
this.shadowRoot.innerHTML = `
  
  
@@##@@ ${name}
`;

3. 支持属性传值与事件通信

为了让组件更灵活,需支持从外部传入数据并对外抛出事件,这能让它在 React 或 Vue 中像普通组件一样绑定 props 和 listeners。

JTBC网站内容管理系统5.0.3.1
JTBC网站内容管理系统5.0.3.1

JTBC CMS(5.0) 是一款基于PHP和MySQL的内容管理系统原生全栈开发框架,开源协议为AGPLv3,没有任何附加条款。系统可以通过命令行一键安装,源码方面不基于任何第三方框架,不使用任何脚手架,仅依赖一些常见的第三方类库如图表组件等,您只需要了解最基本的前端知识就能很敏捷的进行二次开发,同时我们对于常见的前端功能做了Web Component方式的封装,即便是您仅了解HTML/CSS也

下载
  • 通过 observedAttributes 监听属性变化
  • 使用 attributeChangedCallback 响应变更
  • 通过 this.dispatchEvent() 派发自定义事件
示例:点击用户卡片触发事件
static get observedAttributes() {
  return ['name', 'avatar'];
}

attributeChangedCallback(name, oldValue, newValue) { if (oldValue !== newValue) { this.render(); } }

render() { const name = this.getAttribute('name') || '未知'; const avatar = this.getAttribute('avatar') || 'default.png';

this.shadowRoot.innerHTML = zuojiankuohaophpcn!-- 同上 --youjiankuohaophpcn;

// 绑定事件 this.shadowRoot.querySelector('.card').onclick = () => { this.dispatchEvent(new CustomEvent('view-profile', { detail: { name } })); }; }

在 Vue 或 React 中监听:


4. 构建与发布为 npm 包(可选)

如果你希望多个项目共用这个组件,可以将其打包成 npm 包。

  • 使用 Vite、Rollup 等工具将组件构建成标准 ES Module
  • 导出类或调用 define 方法的函数
  • 在目标项目中 import 并注册即可使用
main.js 中注册:
import { UserInfoCard } from 'my-components';
customElements.define('user-info-card', UserInfoCard);

基本上就这些。Web Components 的优势在于“一次封装,到处使用”,只要浏览器支持,就能在任何技术中嵌入。关键是做好属性通信、样式隔离和事件机制,让组件行为清晰可控。头像

相关专题

更多
css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

524

2023.06.15

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

263

2023.07.27

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

757

2023.07.28

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

539

2023.08.01

css字体颜色
css字体颜色

CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

760

2023.08.10

什么是css
什么是css

CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

605

2023.08.10

css三角形怎么写
css三角形怎么写

CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

560

2023.08.21

css设置文字颜色
css设置文字颜色

CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

395

2023.08.22

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Django 教程
Django 教程

共28课时 | 3.3万人学习

React 教程
React 教程

共58课时 | 3.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号