基于HTML模板的自定义组件构建流程

风丽小哥_6447

风丽小哥_6447

2026-07-14

332人浏览

原创

必须在 constructor 中调用 attachshadow(),因浏览器仅允许元素实例化瞬间创建 shadow dom;延迟至 connectedcallback 会因 light dom 已含子节点而报错。

基于html模板的自定义组件构建流程

直接用 <template></template> 配合 Web Components 是最轻量、兼容性最好、不依赖构建工具的方案,但必须把模板克隆时机和 Shadow DOM 初始化顺序搞对,否则内容不渲染或样式泄漏。

为什么必须在 constructor 里调用 attachShadow()

浏览器只允许在元素实例化瞬间(即 constructor 执行时)调用 this.attachShadow()。如果拖到 connectedCallback 再执行,HTML 解析器早已把子节点(比如文本、<slot></slot>)塞进 light DOM,此时再 attach 就会报错:Failed to execute 'attachShadow' on 'Element': Shadow root cannot be created on a host which already has children。

实操建议:

  • constructor 中只做三件事:调用 super()、this.attachShadow({ mode: 'open' })、设置默认属性(如 this._size = 'medium')
  • 所有需要访问子节点、读取 textContent、计算尺寸、操作外部 DOM 的逻辑,一律移到 connectedCallback 中
  • 避免在 constructor 中写 this.innerHTML = '...' —— 这会污染 light DOM,破坏封装性

<template></template> 克隆必须用 cloneNode(true)

直接 appendChild(template.content) 会导致模板被“搬走”,下次实例化时 template.content 为空;而 innerHTML 字符串拼接又无法绑定事件或复用 slot。

实操建议:

  • 模板定义必须带 id,例如 <template id="my-button">...</template>
  • 克隆代码固定为:const tmpl = document.getElementById('my-button').content.cloneNode(true)
  • 插入前检查是否已存在 shadow root:if (this.shadowRoot) this.shadowRoot.appendChild(tmpl),避免重复挂载
  • 若模板含 <slot></slot>,确保组件用法中提供对应命名 slot,否则内容不显示

observedAttributes 不声明就收不到属性变更

HTML 属性变化(如 <my-button disabled></my-button> → <my-button disabled></my-button>)不会自动同步到 JS 属性,也不会触发重绘。即使你在 attributeChangedCallback 里写了 this.disabled = newValue,若没在类里声明 static get observedAttributes(),回调根本不会执行。

html-deploy
html-deploy

使用 htmlcode.fun 将 HTML 内容或文件部署到网页,适用于用户要求“部署到网页”“托管此 HTML”“生成此前端...的实时链接”等场景。

下载

常见错误现象:

  • 修改 <my-button size="large"></my-button> 后样式没变,控制台也无报错
  • 动态执行 el.setAttribute('size', 'small'),组件内部无响应

实操建议:

  • 所有需响应的属性(disabled、label、theme)必须显式列在 observedAttributes 数组中
  • attributeChangedCallback 内优先判断 oldValue !== newValue,避免无效更新
  • 属性值始终是字符串,数值型需手动转换:parseInt(newValue) 或 parseFloat(newValue)

自定义标签名必须含且仅含一个连字符

customElements.define() 对标签名有硬性校验:必须含且仅含一个短横线(-),不能以数字开头,不能是保留字(如 html、script)。写成 mybutton 或 MyButton 都会抛出 DOMException: Failed to execute 'define' on 'CustomElementRegistry': "mybutton" is not a valid custom element name。

实操建议:

  • 命名采用 kebab-case,如 c-button、data-grid、ui-modal
  • 避免使用 x- 前缀(已被历史废弃)、html-(保留字冲突)
  • 注册前先检查是否已定义:if (!customElements.get('c-button')) customElements.define('c-button', CButton)

真正容易被忽略的是:模板 ID 和自定义标签名之间没有强制关联,但一旦模板被多个组件复用,ID 冲突或未查到 getElementById 返回 null,就会静默失败——建议在克隆前加 console.warn 提示模板缺失。

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

相关文章

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

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

下载

相关标签:

html

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

相关专题

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

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

2023.06.14

5355

7

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

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

2023.06.21

3092

4

html网页制作
html网页制作

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

2023.07.31

2750

5

html空格
html空格

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

2023.08.01

2779

5

html是什么
html是什么

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

2023.08.11

4659

6

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

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

2023.08.11

2721

3

html转txt
html转txt

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

2023.08.31

2509

3

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

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

2023.09.01

2268

6

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

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

2023.09.20

2268

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共1课时 | 219人学习