如何在HTML5中使用CustomElements创建一个可复用的自定义UI组件

老磊君_6255

老磊君_6255

2026-06-08

682人浏览

原创

html5 custom elements通过customelements.define()注册继承htmlelement的类,支持影子dom、属性监听、插槽及自定义事件,命名须含短横线,原生兼容主流浏览器。

如何在html5中使用customelements创建一个可复用的自定义ui组件

在HTML5中使用Custom Elements创建可复用UI组件,核心是通过 customElements.define() 注册一个继承自 HTMLElement 的类,并在其生命周期中封装结构、样式和行为。它不依赖框架,原生支持,浏览器兼容性良好(Chrome 67+、Firefox 63+、Safari 13.1+、Edge 79+)。

定义基础结构与注册组件

自定义元素名必须包含短横线(-),如 <my-button></my-button>,这是强制规范,用于区分原生标签。

以下是一个带文本和点击反馈的按钮组件示例:

class MyButton extends HTMLElement {
  constructor() {
    super();
    // 创建影子根(推荐:避免样式/结构污染)
    this.attachShadow({ mode: 'open' });
    
    // 定义默认文本(从属性读取或设为占位)
    const label = this.getAttribute('label') || 'Click me';
    
    // 渲染内部结构
    this.shadowRoot.innerHTML = `
      <style>
        button {
          padding: 8px 16px;
          background: #007bff;
          color: white;
          border: none;
          border-radius: 4px;
          cursor: pointer;
        }
        button:hover { background: #0056b3; }
      </style><button>${label}</button>
    `;
    
    // 绑定事件
    this.shadowRoot.querySelector('button').addEventListener('click', () => {
      this.dispatchEvent(new CustomEvent('my-click', {
        detail: { timestamp: Date.now() }
      }));
    });
  }
}

// 注册组件(名称必须含短横线)
customElements.define('my-button', MyButton);

注册后即可在HTML中直接使用:

<my-button label="Submit"></my-button><script>
  document.querySelector('my-button').addEventListener('my-click', (e) => {
    console.log('触发了自定义点击事件', e.detail);
  });
</script>

响应属性变化(attributeChangedCallback)

若希望组件响应 HTML 属性更新(如 label 或 disabled),需声明 observedAttributes 并实现 attributeChangedCallback:

html-deploy
html-deploy

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

下载
  • 在类中添加静态 getter:static get observedAttributes() { return ['label', 'disabled']; }
  • 实现回调函数,在其中更新 shadow DOM 或内部状态
  • 注意:只有通过 setAttribute、removeAttribute 或 HTML 初始化时设置的属性才会触发该回调;JS 直接赋值如 el.label = 'new' 不会触发(除非也重写 setter)

例如同步 disabled 状态到内部按钮:

attributeChangedCallback(name, oldValue, newValue) {
  if (name === 'disabled') {
    const btn = this.shadowRoot.querySelector('button');
    if (btn) {
      btn.disabled = newValue !== null;
      btn.style.opacity = newValue !== null ? '0.6' : '1';
    }
  }
}

支持插槽(Slot)实现内容分发

让组件支持传入任意 HTML 内容(类似 Vue 的 <slot></slot> 或 React 的 children),使用 <slot></slot> 标签即可:

  • 在 shadow DOM 中放置 <slot></slot> 作为内容出口
  • 外部使用时,在开始与结束标签之间写内容,会被自动渲染进 slot 位置
  • 支持具名 slot:<slot name="icon"></slot> + <span slot="icon">?</span>

升级上面的按钮,支持自定义内容:

// 替换 innerHTML 中的 button 标签为:
`<style>...</style><button><slot>${label}</slot></button>`

然后这样使用:

<my-button><strong>✅ Confirm</strong>
</my-button>

封装常用逻辑与最佳实践

  • 始终使用 Shadow DOM:隔离样式和结构,防止全局 CSS 污染,也避免组件内部被外部样式意外影响
  • 属性与属性反射保持一致:若提供 disabled 属性,建议同时实现 disabled getter/setter,使 JS 操作更自然
  • 事件优先用 CustomEvent:避免使用原生事件名(如 click),防止与内置行为冲突;命名建议带前缀(如 my-change)
  • 支持无障碍(a11y):手动设置 role、aria- 属性,尤其当语义化标签(如 <button></button>)被隐藏或替换时
  • 避免在 constructor 中操作文档或发起网络请求:此时元素尚未插入 DOM,且构造函数应保持轻量

自定义元素不是黑魔法,而是标准化的扩展机制。写好一个,就能跨项目、跨框架复用——只要浏览器支持,它就在那儿,安静、可靠、无需打包配置。

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

相关文章

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

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

下载

相关标签:

html5 html

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

相关专题

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

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

2023.08.11

2283

5

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

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

2023.10.09

4923

6

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

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

2024.03.19

6010

13

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

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

2024.03.22

5518

10

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

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

2024.05.22

783

5

html版权符号
html版权符号

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

2023.06.14

5595

7

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

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

2023.06.21

3192

4

html网页制作
html网页制作

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

2023.07.31

2850

5

html空格
html空格

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

2023.08.01

2879

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
HTML5/CSS3/JavaScript/ES6入门课程
HTML5/CSS3/JavaScript/ES6入门课程

共102课时 | 10.7万人学习

HTML+CSS基础与实战
HTML+CSS基础与实战

共132课时 | 18.7万人学习

前端开发(基础+实战项目合集)
前端开发(基础+实战项目合集)

共60课时 | 6.4万人学习