如何使用HTML自定义元素构建富文本编辑器

P粉328763957

P粉328763957

2026-07-20

807人浏览

原创

不能用 customelements.define() 直接封装富文本编辑器,因自定义元素不解决 selection、formatting 等核心问题;contenteditable 必须置于 light dom 中,shadow dom 内启用会导致聚焦、选区、粘贴等异常;connectedcallback 仅能做初始化,需 requestanimationframe 延迟绑定事件;innerhtml 不可信,须用 domparser 清洗;光标与撤销逻辑复杂,建议集成 tiptap 或 prosemirror。

如何使用html自定义元素构建富文本编辑器

不能用 customElements.define() 直接封装出一个可用的富文本编辑器——自定义元素只负责 DOM 结构和生命周期,不解决 selection、formatting、paste 清洗、undo 栈这些核心问题。

为什么 contenteditable 必须放在内部,不能由 custom element 自动接管

自定义元素(如 <rich-text-editor></rich-text-editor>)本身是 Shadow DOM 容器或普通元素,但浏览器对 contenteditable 的支持仅限于 light DOM 中的可聚焦节点。Shadow DOM 内启用 contenteditable 会导致:

  • 光标无法稳定聚焦(尤其在 Safari 和旧版 Chrome)
  • window.getSelection() 返回空或错位 range
  • 粘贴事件(paste)不触发,或 event.clipboardData 为空
  • 键盘导航(Tab、Arrow)在 Shadow 内行为异常

实际做法:自定义元素只作为“壳”,内部必须暴露一个 light DOM 子节点(如 <div contenteditable="true">),且该节点不能被 <code>slotattachShadow 隔离。

connectedCallback 里能做的事很有限

自定义元素挂载时,你只能做初始化准备,不能直接调用格式化逻辑:

  • 不能在 connectedCallback 里调用 document.execCommand() —— 此时编辑区还没 focus,selection 为空
  • 不能靠 this.innerHTML = '<div contenteditable>' 就完事,需等元素渲染完成再监听事件(推荐用 <code>requestAnimationFrame 延迟一次)
  • 工具栏按钮绑定命令时,目标 document 必须明确:document.execCommand() 作用于当前 window,若编辑区在 iframe 内则失效
  • 正确姿势示例:

    使用HTML,CSS,JavaScript开发Android应用程序 英文文字pdf版附源文件
    使用HTML,CSS,JavaScript开发Android应用程序 英文文字pdf版附源文件

    如果你了解HTML,CSS和JavaScript,您已经拥有所需的工具开发Android应用程序。本动手本书展示了如何使用这些开源web标准设计和建造,可适应任何Android设备的应用程序 - 无需使用Java。您将学习如何创建一个在您选择的平台的Andr​​oid友好的网络应用程序,然后转换与自由PhoneGap框架到一个原生的Andr​​oid应用程序。了解为什么设备无关的移动应用是未来的潮流,并开始构建应用程序,提供更

    下载
    connectedCallback() {
      this.innerHTML = `<div class="toolbar"><button data-command="bold">B</button></div>
                        <div contenteditable="true" class="editor"></div>`;
      // 等渲染完成
      requestAnimationFrame(() => {
        const editor = this.querySelector('.editor');
        editor.addEventListener('focus', () => this.#syncToolbarState());
        this.querySelector('.toolbar').addEventListener('click', e => {
          if (e.target.hasAttribute('data-command')) {
            document.execCommand(e.target.dataset.command, false, null);
          }
        });
      });
    }

    输出 HTML 时,innerHTML 不可信

    用户粘贴 Word 或网页内容后,editor.innerHTML 会混入:<span style="font-family: Calibri"></span><div class="MsoNormal">、多余 <code><br>、嵌套 <font></font>。直接存库或渲染将导致样式污染和语义混乱。

    • 必须递归遍历节点,把 <b></b><strong></strong><font color></font><span style="color:"></span>
    • 过滤掉空 <span></span>、孤立 <br>、无意义 class(如 Mso*
    • 避免用正则替换 HTML 字符串——DOM 解析更可靠:new DOMParser().parseFromString(html, 'text/html')

    简单清洗示意:

    getHTML() {
      const doc = new DOMParser().parseFromString(this.editor.innerHTML, 'text/html');
      const clean = doc.body;
      clean.querySelectorAll('b, font, span[style]').forEach(el => {
        if (el.tagName === 'B') el.replaceWith(el.outerHTML.replace(/<b>/gi, '<strong>').replace(//gi, ''));
        if (el.tagName === 'FONT' || el.hasAttribute('style')) {
          const span = document.createElement('span');
          span.innerHTML = el.innerHTML;
          if (el.hasAttribute('color')) span.style.color = el.getAttribute('color');
          el.replaceWith(span);
        }
      });
      return clean.innerHTML;
    }</strong></b>

    真正卡住人的不是加粗,而是光标和撤销

    手写编辑器最难 debug 的永远是:

    • 用户按 Ctrl+Z 后,光标停在错误位置(尤其跨 <p></p> 选区后撤销)
    • Shift+Enter 在 iOS 上被忽略,keydown 拦截后 event.preventDefault() 可能阻断换行
    • 选中文字后点加粗,结果只包裹了部分节点(range.surroundContents() 报错,因选区跨块级元素)
    • 粘贴后光标跳到开头,而不是留在粘贴位置末端

    这些不是 API 调用顺序问题,而是 Selection/Range 边界 case 处理缺失。除非团队有人持续维护过这类逻辑,否则建议直接集成 TiptapProseMirror——它们已覆盖 90% 以上真实场景的光标与撤销行为。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.06.14

2596

7

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

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

2023.06.21

1700

4

html网页制作
html网页制作

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

2023.07.31

1437

5

html空格
html空格

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

2023.08.01

1366

5

html是什么
html是什么

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

2023.08.11

3707

6

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

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

2023.08.11

1393

3

html转txt
html转txt

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

2023.08.31

1152

3

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

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

2023.09.01

1081

6

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

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

2023.09.20

1012

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

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

共1课时 | 156人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 5万人学习