HTML工程化:利用Web Component构建可维护的UI组件

千晨同学_6332

千晨同学_6332

2026-07-14

482人浏览

原创

自定义元素名必须含短横线,如quark-button;shadow dom mode须为open;attributechangedcallback仅响应observedattributes声明的属性变更;跨框架需手动适配事件并同步属性更新。

html工程化:利用web component构建可维护的ui组件

自定义元素名必须带短横线,否则会报错

浏览器强制要求自定义元素名包含至少一个短横线(-),否则调用 customElements.define 时直接抛出错误:Failed to execute 'define' on 'CustomElementRegistry': The name "mybutton" is not a valid custom element name。

常见无效写法包括:mybutton(无短横线)、-my-btn(开头连字符)、my-btn-(结尾连字符)、123(纯数字)、abc(纯字母)。合法命名惯例是全小写 + 短横线分隔,比如 quark-button、user-card、data-input-field。

大小写不敏感,但混用大小写(如 MyButton)不仅违反惯例,还可能在某些构建流程中引发路径或注册冲突。

Shadow DOM mode 必须选 open,closed 基本不可用

attachShadow({ mode: 'open' }) 是绝大多数场景的唯一合理选择。它让 el.shadowRoot 可访问,支持 DevTools 查看结构、Jest 测试中查询内部节点、Puppeteer 自动化定位元素——这些是工程化落地的基础能力。

mode: 'closed' 会让 shadowRoot 返回 null,导致:

  • 无法在浏览器开发者工具中展开 Shadow DOM 节点
  • querySelector 或 shadowRoot.querySelector 失效
  • 所有依赖影子树探测的测试/调试/集成工具链中断

除非你明确需要防样式劫持(如金融类组件),否则 closed 不是“更安全”,而是“不可维护”。且 attachShadow 只能调用一次,重复调用会报错:This element already has a shadow root。

Wechat Article Html
Wechat Article Html

将 Markdown 文章转换为微信公众号兼容的纯 HTML 格式。当用户要求"转成微信格式"、"生成公众号文章 HTML"、"排版到微信草稿箱"、"微信粘贴格式"时触发。输出带内联样式的纯 HTML,微信编辑器可直接渲染,无需额外适配。支持标题、段落、列表、粗体、行内代码、表格、引用块、代码块、配图的完整转换。

下载

attributeChangedCallback 不触发?先检查 observedAttributes

这个回调只响应你在 static get observedAttributes() 中显式声明的属性,并且仅对以下三种方式生效:el.setAttribute('loading', 'true')、el.removeAttribute('loading')、或 HTML 标签内写死 <my-button loading></my-button>。JS 直接赋值 el.loading = true 不会触发。

排查要点:

  • observedAttributes 必须返回字符串数组,例如 return ['loading', 'disabled'],不能是对象或单个字符串
  • 属性名严格匹配:写成 'Loading' 或 'LOADING' 都不会监听到 loading
  • 不要在 constructor 中就设置属性值,此时 connectedCallback 尚未执行,回调不会立即运行

如果想监听布尔属性(如 loading),HTML 中必须用存在即真语义:<my-button loading></my-button>,而不是 <my-button loading="true"></my-button> —— 后者会被当作字符串值处理。

跨框架使用时,事件需手动适配 React/Vue

Web Components 发出的事件(如 new CustomEvent('click'))默认是冒泡的,但在 React 中不会自动映射为 onClick,Vue 中也不会绑定为 @click。必须显式处理:

  • React:用 ref 获取原生元素后,调用 addEventListener;或封装一层 wrapper 组件做事件代理
  • Vue:使用 v-on 的修饰符 @click.native(Vue 2)或 @click.capture(Vue 3),或通过 defineCustomElement 工具链生成适配器

Quark Design 提供了 packages/quark-reactify 这类工具库,本质就是把 quark-button 的 click 事件转成 React 的合成事件流。裸用 Web Components 时,这部分适配必须自己补上,否则交互逻辑会静默失效。

真正容易被忽略的是:组件内部状态变更(比如按钮点击后切换 loading 状态)必须同步更新属性,并触发 attributeChangedCallback,否则父框架无法感知变化——这不像 React/Vue 的响应式系统会自动同步。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

HTML怎么学习?HTML怎么入门?HTML在哪学?HTML怎么学才快?不用担心,这里为大家提供了HTML速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

html

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

6595

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

3672

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

3350

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

3359

5

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2023.08.11

5019

6

html字体大小怎么设置
html字体大小怎么设置

在网页设计中,字体大小的选择是至关重要的。合理的字体大小不仅可以提升网页的可读性,还能够影响用户对网页整体布局的感知。php中文网将介绍一些常用的方法和技巧,帮助您在HTML中设置合适的字体大小。

2023.08.11

3301

3

html转txt
html转txt

html转txt的方法有使用文本编辑器、使用在线转换工具和使用Python编程。本专题为大家提供html转txt相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

3129

3

html文本框代码怎么写
html文本框代码怎么写

html文本框代码:1、单行文本框【<input type="text" style="height:..;width:..;" />】;2、多行文本框【textarea style=";height:;"></textare】。

2023.09.01

2728

6

HTML嵌入CSS样式的方法
HTML嵌入CSS样式的方法

HTML嵌入CSS样式的方法有内联样式、内部样式表和外部样式表。本专题为大家提供CSS样式相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.20

2828

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
两小时学会 Webpack
两小时学会 Webpack

共14课时 | 2.1万人学习

Node.js-前端工程化必学
Node.js-前端工程化必学

共19课时 | 3.6万人学习

前端工程化(ES6模块化和webpack打包)
前端工程化(ES6模块化和webpack打包)

共24课时 | 5.8万人学习