Web Components 怎么编写符合规范的自定义组件文档

胖浩姑娘_7633

胖浩姑娘_7633

2026-08-16

857人浏览

原创

web components 规范要求:①命名须小写+短横线(如my-button);②constructor仅调用super()和attachshadow();③属性监听需声明observedattributes并响应attributechangedcallback;④内容分发依赖slot,样式须置于shadow dom内。

web components 怎么编写符合规范的自定义组件文档

编写符合规范的 Web Components 自定义组件,核心是严格遵循浏览器原生标准,不是写得“能用”就行,而是要避开常见陷阱、保证可维护性和跨环境稳定性。下面从命名、结构、生命周期、内容分发四个关键点说清楚。

自定义元素名必须含短横线且全小写

这是硬性校验,不满足直接抛 DOMException。浏览器靠短横线(kebab-case)区分原生标签和自定义标签,防止未来冲突。

  • ✅ 合法:data-table、my-button、x-slider —— 全小写 + 至少一个短横线 + 不在首尾
  • ❌ 非法:mybutton(缺短横线)、MyButton(含大写)、-my-btn(短横线开头)、my-btn-(结尾)、123abc(纯数字字母)
  • 注册时必须用 customElements.define('my-button', MyButton),名字和类名不强制一致,但建议保持语义对应

constructor 中只做初始化,不操作 DOM 或属性

此时元素尚未挂载,this.shadowRoot 为空,this.getAttribute() 可能读不到初始值,强行操作易失败或被静默忽略。

HTML Extract
HTML Extract

使用 MinerU 从 HTML 页面和文件中提取内容,将 HTML 转换为保持标题、列表、表格及文本层次结构的干净、结构化 Markdown。F...

下载
  • 必须调用 super(),否则继承链断裂
  • 必须在此处调用 this.attachShadow({ mode: 'open' }),且只能一次;重复调用会报错
  • 不要读 this.innerHTML、this.children 或设置子节点;也不要在 constructor 里调用 setAttribute
  • 如需初始化 shadow DOM 内容,留到 connectedCallback 中处理

属性变更必须显式声明并响应

attributeChangedCallback 不是自动监听所有属性,它只对 observedAttributes 白名单里的 HTML 属性生效,且仅响应通过 setAttribute、removeAttribute 或模板中写死的变更。

  • 在类中定义静态 getter:static get observedAttributes() { return ['disabled', 'loading']; }
  • 属性名大小写必须完全一致,'disabled' ≠ 'Disabled'
  • JS 直接赋值(如 el.disabled = true)不会触发该回调,如需响应,应配合 setter 或改用其他机制
  • 回调中可安全操作 this.shadowRoot,但注意:首次挂载时属性可能已存在,需兼容初始值

slot 是内容分发的唯一标准方式

没有 <slot></slot>,外部传入的子内容(比如 <my-card>Hello</my-card> 中的 Hello)就完全不可见,也不会渲染。

  • <slot></slot> 支持 name 属性实现具名分发,如 <slot name="header"></slot>
  • 默认内容写在 <slot></slot> 标签内,当无对应内容插入时显示
  • 若需监听 slot 内容变化(比如用户动态增删子节点),需手动监听 slotchange 事件:shadowRoot.querySelector('slot').addEventListener('slotchange', ...)
  • 样式必须写在 shadow DOM 内(如 shadowRoot.innerHTML = '<style>...</style>...'),外部 CSS 默认无法穿透

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

html

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

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2183

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

4683

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5830

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

5258

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

743

5

js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4366

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1089

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4284

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

860

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 219人学习