讲师中心 微信公众号
AI工具推荐 视频效率加速

HTML自定义元素类型安全检查的用法是什么?

浅明姑娘_8921

浅明姑娘_8921

发布时间:2026-07-02 13:58:25

|

537人浏览过

|

来源于php中文网

原创

TypeScript 报 TS2351 错误是因为未注册自定义元素就直接使用,需在 JSX.IntrinsicElements 中声明并确保 customElements.define 已调用,否则运行时为 null;访问自定义属性须定义专属接口断言,不可仅用 as HTMLElement 或 as any。

html自定义元素类型安全检查的用法是什么?

自定义元素没注册就用,TypeScript 会报 TS2351 错误

浏览器允许你写 <my-button></my-button>,但 TypeScript 默认不认识这个标签——它不是内置元素(如 <div>),也不是 React 组件,编译器直接当语法错误处理。

常见错误现象:Cannot use JSX element type 'my-button'. Type '"my-button"' is not assignable to type 'JSX.IntrinsicElements'

  • 必须在全局 JSX.IntrinsicElements 接口中显式声明,例如:
    declare global {
      namespace JSX {
        interface IntrinsicElements {
          'my-button': React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
          'data-grid': React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
        }
      }
    }
  • 声明后仍需确保运行时已调用 customElements.define('my-button', ...),否则 DOM 操作时是 null,和普通元素一样要判空
  • 别只声明标签名却不指定属性类型——比如漏掉 disabled 或 data-id,后续访问 el.disabled 仍会触发 TS2339

用 as HTMLElement 断言会丢失自定义属性类型

获取自定义元素后写 document.querySelector('my-button') as HTMLElement,看似能过编译,但后续访问 el.myProp 或 el.setAttribute('loading', 'true') 依然报错。

根本原因:TypeScript 的 HTMLElement 接口不包含你的自定义属性或方法。

html-to-pptx
html-to-pptx

将多页 HTML 演示文稿转换为美化的 PPTX 文件,便于分享和分发。

下载

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

  • 正确做法是定义专属接口并断言:
    interface MyButtonElement extends HTMLElement {
      loading: boolean;
      label: string;
      onClick(): void;
    }
    const btn = document.querySelector('my-button') as MyButtonElement;
    btn.loading = true; // ✅ 不报错
  • 如果元素可能未升级(即刚插入 DOM 还没被 customElements 定义识别),要用 instanceof 守卫:if (btn instanceof MyButtonElement) { ... }
  • 避免用 as any 或 ! 非空断言——它们绕过类型检查,等于放弃类型安全

TSX 中使用自定义元素要配 JSX.LibraryManagedAttributes

在 React 或类似框架的 TSX 文件里直接写 <my-button label="submit" />,即使已声明 IntrinsicElements,仍可能报属性缺失错误。

这是因为 TSX 默认只认标准 HTML 属性,而 label 是你自定义的 property,不是 attribute。

  • 需要补充 LibraryManagedAttributes 类型,告诉 TypeScript 如何映射 props 到元素实例:
    declare global {
      namespace JSX {
        interface LibraryManagedAttributes<C, P> {
          // 对自定义元素,把 props 直接映射为 element 实例属性
          C extends CustomElementConstructor ? P : P;
        }
      }
    }
  • 更稳妥的做法是封装一层 React 组件包装自定义元素,用 React.forwardRef + useImperativeHandle 暴露方法,由 TSX 类型系统统一管理
  • 注意:若自定义元素用的是 attributeChangedCallback 响应属性变更,那传入的 props 应转成字符串 attribute;若用的是 property setter,则需确保 TSX 编译器知道该 prop 是 runtime property 而非 HTML attribute

检查是否注册成功的运行时判断比类型声明更重要

类型声明只是让编译通过,真正出问题的是运行时——customElements.get('my-button') 返回 undefined 时,new MyButtonElement() 会失败,document.createElement('my-button') 创建的是普通 HTMLElement。

  • 建议在初始化逻辑中加守卫:
    if (!customElements.get('my-button')) {
      console.error('Custom element "my-button" not defined');
      throw new Error('Missing web component registration');
    }
  • 单元测试里不要只测 TS 编译,要实际调用 customElements.define 后再做 DOM 查询和属性赋值
  • 构建工具(如 Vite)若启用 define 注入或动态 import,要注意注册时机早于元素首次渲染,否则 SSR 或首屏 JS 执行顺序错乱会导致类型和运行时不一致
自定义元素的类型安全不是靠一次声明就一劳永逸,它横跨声明、注册、实例化、属性访问四个环节,任一环节漏掉运行时校验,类型系统就形同虚设。

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

5155

2023.06.14

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

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

2992

2023.06.21

html网页制作
html网页制作

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

2650

2023.07.31

html空格
html空格

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

2699

2023.08.01

html是什么
html是什么

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

4619

2023.08.11

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

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

2641

2023.08.11

html转txt
html转txt

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

2409

2023.08.31

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

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

2208

2023.09.01

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

140

2026.09.23

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共1课时 | 214人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn