0

0

javascript的custom elements如何定义_如何创建和使用自己的html元素【教程】

夢幻星辰

夢幻星辰

发布时间:2026-01-16 20:34:03

|

703人浏览过

|

来源于php中文网

原创

Custom Elements 是 Web Components 的核心,需继承 HTMLElement、含短横线命名,用 customElements.define() 注册;构造函数必须调用 super() 初始化 this,attributeChangedCallback 仅响应 observedAttributes 中声明的属性变更,且受浏览器兼容性与 DOM 结构限制。

javascript的custom elements如何定义_如何创建和使用自己的html元素【教程】

Custom Elements 是 Web Components 的核心之一,它允许你定义自己的 HTML 标签,但不是靠封装或模拟,而是真正注册进浏览器的 DOM 系统——这意味着 document.createElement('my-button') 能返回合法元素,instanceof 会通过校验,且能被 querySelector、框架的 ref、甚至原生表单逻辑识别。

如何用 customElements.define() 注册一个自定义元素

必须继承 HTMLElement(或其子类如 HTMLButtonElement),且类名中必须含短横线(-),这是强制语法限制,否则抛出 DOMException: The element name must contain a hyphen

  • 类不能是匿名函数或箭头函数,必须有命名(哪怕只是 class MyCard extends HTMLElement
  • 注册前必须先声明类,顺序不能颠倒;若重复注册同一名称,会报错 Failed to execute 'define' on 'CustomElementRegistry': the name "x-foo" has already been used
  • 名称不能以 x- 开头再加短横线(如 x-foo-bar 合法,x--foo 不合法),也不能是保留名(如 htmlslottemplate
class MyCounter extends HTMLElement {
  constructor() {
    super();
    this.count = 0;
    this.attachShadow({ mode: 'open' });
    this.shadowRoot.innerHTML = `
      
      
    `;
  }

  connectedCallback() {
    this.shadowRoot.querySelector('button').addEventListener('click', () => {
      this.count++;
      this.shadowRoot.querySelector('button').textContent = `${this.textContent}: ${this.count}`;
    });
  }
}

customElements.define('my-counter', MyCounter);

为什么必须用 constructor + super()

因为 Custom Element 构造函数在 DOM 初始化阶段被调用(比如解析 HTML 字符串时),此时元素尚未插入文档,也无父节点。不调用 super() 会导致 this 未初始化,后续所有操作(如 attachShadowsetAttribute)都会失败,并静默报错或直接崩溃。

  • connectedCallbackdisconnectedCallback 可以安全访问 this.parentNode,但 constructor 里永远不能
  • attributeChangedCallback 的触发前提是:该属性在 observedAttributes 中声明,且元素已定义完成——也就是说,它不会在 constructor 执行期间触发
  • 不要在 constructor 里调用 this.innerHTML 或读取 this.children,它们为空;应改用 slotinnerHTML 写入 shadow DOM

如何让自定义元素支持 HTML 属性并响应变更

仅靠 setAttribute 不会自动触发更新,必须显式监听属性变化。浏览器只会在属性值字符串发生变化时调用 attributeChangedCallback,且仅限于 observedAttributes 返回的数组中列出的属性名。

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

羚珑
羚珑

京东推出的一站式AI图像处理平台

下载
  • 属性名自动转为小写(My-Propmy-prop),所以 observedAttributes 必须写小写形式
  • 若属性初始值来自 HTML(如 ),attributeChangedCallback 会在 connectedCallback 前触发一次
  • 注意:布尔属性(如 disabled)的变更,newValue""(空字符串)而非 true;需用 this.hasAttribute('disabled') 判断
class MyInput extends HTMLElement {
  static get observedAttributes() {
    return ['value', 'disabled'];
  }

  attributeChangedCallback(name, oldValue, newValue) {
    switch (name) {
      case 'value':
        this.input.value = newValue || '';
        break;
      case 'disabled':
        this.input.disabled = this.hasAttribute('disabled');
        break;
    }
  }

  constructor() {
    super();
    this.attachShadow({ mode: 'open' });
    this.shadowRoot.innerHTML = ``;
    this.input = this.shadowRoot.querySelector('input');
  }
}

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

使用时要注意哪些兼容性与陷阱

Chrome / Edge / Safari 原生支持良好,Firefox 从 63+ 支持,但 IE 完全不支持(无 polyfill 可完美还原行为)。即便现代浏览器,也有几个容易忽略的点:

  • 自定义元素无法直接作为 的子元素(如 放在 里)——浏览器会把它“提升”到 table 外,破坏结构;必须用 is 语法:
  • 服务端渲染(SSR)时,若 JS 未加载,自定义元素会表现为未知标签,样式和交互全部失效;建议配合 customElements.whenDefined() 做降级处理
  • 若元素内使用了 slot,且宿主元素有 innerHTML 设置,内容不会自动投射——必须等 connectedCallback 触发后才生效
  • 最常被跳过的一步:没检查是否已定义就重复 define,尤其在模块热更新或微前端场景下。上线前务必加一层守卫:

    if (!customElements.get('my-card')) {
      customElements.define('my-card', MyCard);
    }

    真正的难点不在语法,而在生命周期节奏——什么时候能读 DOM、什么时候能改样式、什么时候能发事件,全都取决于你对 constructor / connectedCallback / attributeChangedCallback 三者触发时机和约束条件的理解是否精确。

相关专题

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

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

554

2023.06.20

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

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

374

2023.07.04

js四舍五入
js四舍五入

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

731

2023.07.04

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

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

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

991

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

657

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.16

热门下载

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

精品课程

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

共58课时 | 3.7万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.2万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

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

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