0

0

怎样使用Web Components构建可复用的自定义HTML元素?

狼影

狼影

发布时间:2025-10-08 17:34:01

|

707人浏览过

|

来源于php中文网

原创

使用Web Components可创建独立可复用的自定义元素,1. 通过继承HTMLElement并用customElements.define()注册组件;2. 利用影子DOM实现样式和结构隔离;3. 结合template标签提升代码组织性与性能;4. 使用slot插入外部内容以增强灵活性;5. 通过observedAttributes和attributeChangedCallback响应属性变化。该技术不依赖框架,适合构建跨项目UI库,需注意浏览器兼容性。

怎样使用web components构建可复用的自定义html元素?

使用 Web Components 构建可复用的自定义 HTML 元素,核心在于利用浏览器原生支持的几项技术:自定义元素(Custom Elements)、影子 DOM(Shadow DOM)和 HTML 模板(template)。通过它们可以封装样式、结构和行为,实现真正独立、可复用的组件。

定义自定义元素

要创建一个可复用的自定义元素,首先需要继承 HTMLElement 并通过 customElements.define() 注册。元素名称必须包含连字符(-),以避免与原生 HTML 标签冲突。

例如:
class MyButton extends HTMLElement {
  constructor() {
    super();
    this.textContent = this.getAttribute('label') || '点击我';
    this.style.padding = '10px 20px';
    this.style.backgroundColor = '#007bff';
    this.style.color = 'white';
    this.style.borderRadius = '4px';
    this.style.display = 'inline-block';
    this.style.cursor = 'pointer';
  }

  connectedCallback() {
    this.addEventListener('click', () => {
      alert('按钮被点击!');
    });
  }
}

customElements.define('my-button', MyButton);

之后就可以在 HTML 中使用:
<my-button label="提交"></my-button>

使用影子 DOM 封装样式和结构

为了让组件样式不被外部影响,也防止组件内部样式泄漏到全局,应使用影子 DOM。在构造函数中调用 this.attachShadow({ mode: 'open' }) 创建影子根。

立即学习前端免费学习笔记(深入)”;

改进后的例子:
class MyCard extends HTMLElement {
  constructor() {
    super();
    const shadow = this.attachShadow({ mode: 'open' });

    const wrapper = document.createElement('div');
    const title = document.createElement('h3');
    const content = document.createElement('p');

    title.textContent = this.getAttribute('title') || '默认标题';
    content.textContent = this.getAttribute('content') || '这是内容';

    const style = document.createElement('style');
    style.textContent = `
      div {
        border: 1px solid #ddd;
        border-radius: 8px;
        padding: 16px;
        background: #f9f9f9;
        font-family: sans-serif;
      }
      h3 { color: #333; margin-top: 0; }
      p { color: #555; }
    `;

    wrapper.appendChild(title);
    wrapper.appendChild(content);
    shadow.appendChild(style);
    shadow.appendChild(wrapper);
  }
}

customElements.define('my-card', MyCard);

现在这个卡片组件的样式完全隔离,不会受页面其他 CSS 影响。

Winston AI
Winston AI

强大的AI内容检测解决方案

下载

结合 template 提高可维护性

对于结构较复杂的组件,推荐使用 <template> 标签预定义 DOM 结构,提升代码组织性和性能。

HTML 中定义模板:
<template id="my-modal-template">
  <style>
    .modal {
      display: none;
      position: fixed;
      top: 0; left: 0;
      width: 100%; height: 100%;
      background: rgba(0,0,0,0.5);
      align-items: center;
      justify-content: center;
    }
    .modal.active {
      display: flex;
    }
    .modal-content {
      background: white;
      padding: 20px;
      border-radius: 8px;
      max-width: 500px;
    }
  </style>
  <div class="modal">
    <div class="modal-content">
      <slot></slot>
    </div>
  </div>
</template>
JS 中使用模板:
class MyModal extends HTMLElement {
  constructor() {
    super();
    const template = document.getElementById('my-modal-template');
    const content = template.content.cloneNode(true);
    this.shadowRoot = this.attachShadow({ mode: 'open' });
    this.shadowRoot.appendChild(content);

    this.modal = this.shadowRoot.querySelector('.modal');
  }

  show() {
    this.modal.classList.add('active');
  }

  hide() {
    this.modal.classList.remove('active');
  }
}

customElements.define('my-modal', MyModal);

通过 slot 可以让使用者传入自定义内容,增强灵活性。

监听属性变化响应更新

如果希望组件对属性变化做出反应,可以使用 static get observedAttributes() 定义需监听的属性,并实现 attributeChangedCallback 方法。

示例:
class MyInput extends HTMLElement {
  static get observedAttributes() {
    return ['value', 'disabled'];
  }

  attributeChangedCallback(name, oldValue, newValue) {
    if (name === 'value') {
      this.input.value = newValue;
    }
    if (name === 'disabled') {
      this.input.disabled = newValue !== null;
    }
  }

  constructor() {
    super();
    this.attachShadow({ mode: 'open' });
    this.input = document.createElement('input');
    this.shadowRoot.appendChild(this.input);
  }
}

customElements.define('my-input', MyInput);

这样当设置 <my-input value="测试" disabled></my-input> 时,组件会自动更新状态。

基本上就这些。Web Components 不依赖任何框架,适合构建跨项目、跨团队使用的 UI 组件库。虽然功能强大,但要注意浏览器兼容性,必要时引入 polyfill。关键是合理封装、暴露清晰 API,才能真正实现“一次编写,到处复用”。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
typedef和define区别
typedef和define区别

typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

119

2023.09.26

define的用法
define的用法

define用法:1、定义常量;2、定义函数宏:3、定义条件编译;4、定义多行宏。更多关于define的用法的内容,大家可以阅读本专题下的文章。

391

2023.10.11

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

531

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

576

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

6305

2023.08.17

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

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

494

2023.09.01

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

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

精品课程

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

共14课时 | 0.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

CSS教程
CSS教程

共754课时 | 43.5万人学习

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

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