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

如何在 contenteditable 元素中实现语法高亮并保持光标位置稳定

大瑶大大_9369

大瑶大大_9369

发布时间:2026-07-04 15:38:31

|

130人浏览过

|

来源于php中文网

原创

本文提供一种可靠方案,解决在 contenteditable div 中动态插入 html(如关键词高亮)后光标重置到开头的问题,通过精确计算光标偏移、安全重建 dom 和合理使用 range api 实现光标位置保持。

本文提供一种可靠方案,解决在 contenteditable div 中动态插入 html(如关键词高亮)后光标重置到开头的问题,通过精确计算光标偏移、安全重建 dom 和合理使用 range api 实现光标位置保持。

在基于 contenteditable 的简易代码编辑器中,为关键词(如 let、const)添加语法高亮时,直接修改 innerHTML 会破坏当前 DOM 结构,导致光标(caret)意外跳转至起始位置(offset 0),甚至抛出 DOMException: Selection.setPosition: The offset is out of range 错误。根本原因在于:textContent 是纯文本视图,而 innerHTML 操作会将文本重新解析为 DOM 节点,原有光标锚点(anchor node + offset)所指向的文本位置可能已不存在于新生成的节点树中。

✅ 正确思路:避免依赖 anchorOffset,改用字符级偏移 + 安全光标恢复

原代码试图通过 selection.anchorOffset 计算插入位置,但该值在 contenteditable 中语义模糊(尤其在多节点结构下),且 editor.firstChild 不一定存在或不匹配预期。更鲁棒的做法是:

  1. 以纯文本为基准:始终用 innerText(而非 textContent)获取用户可见内容,它能更好反映渲染后的文本流;
  2. 延迟高亮时机:不在每次输入都全量重渲染,而是仅在检测到关键词变化时触发高亮;
  3. 光标重定位采用 Range + setStartAfter() 策略:不依赖易失效的 setPosition(),而是将光标置于最后一个子节点末尾(适用于追加式编辑场景),或通过遍历节点精确定位到对应字符位置。

以下是优化后的完整实现(兼容 Firefox 及现代浏览器):

<div id="editor" contenteditable="true"></div>
<style>
#editor {
  min-height: 120px;
  min-width: 250px;
  border: 1px solid #ccc;
  padding: 8px;
  font-family: monospace;
  white-space: pre-wrap;   /* 关键:保留换行与空格,支持多行 */
  word-wrap: break-word;
}
.keyword {
  color: #d73a49;
  font-weight: bold;
}
</style>
<script>
const editor = document.getElementById("editor");
const keywords = ["function", "var", "let", "const", "if", "else", "for", "while", "return"];
const keywordRegex = new RegExp(`\b(${keywords.join('|')})\b`, 'g');

function highlightKeywords() {
  const text = editor.innerText; // 获取用户实际看到的文本
  const html = text.replace(keywordRegex, '<span class="keyword">$&</span>');

  // 暂存当前光标位置(字符索引)
  const selection = window.getSelection();
  let cursorPos = 0;
  if (selection.rangeCount > 0) {
    const range = selection.getRangeAt(0);
    const preCaretRange = range.cloneRange();
    preCaretRange.selectNodeContents(editor);
    preCaretRange.setEnd(range.endContainer, range.endOffset);
    cursorPos = preCaretRange.toString().length;
  }

  // 应用高亮(重置 innerHTML)
  editor.innerHTML = html;

  // 安全恢复光标:定位到第 cursorPos 个字符处
  restoreCaretPosition(cursorPos);
}

function restoreCaretPosition(targetCharIndex) {
  const range = document.createRange();
  const selection = window.getSelection();
  let count = 0;

  function traverse(node) {
    if (node.nodeType === Node.TEXT_NODE) {
      const len = node.textContent.length;
      if (count + len >= targetCharIndex) {
        // 找到目标文本节点及偏移
        range.setStart(node, targetCharIndex - count);
        range.collapse(true);
        selection.removeAllRanges();
        selection.addRange(range);
        return true;
      }
      count += len;
    } else {
      for (let child of node.childNodes) {
        if (traverse(child)) return true;
      }
    }
    return false;
  }

  traverse(editor);
  // 若未精确定位(如超出范围),默认置于末尾
  if (selection.rangeCount === 0 || !selection.getRangeAt(0).commonAncestorContainer.contains(editor)) {
    range.selectNodeContents(editor);
    range.collapse(false);
    selection.removeAllRanges();
    selection.addRange(range);
  }
}

// 绑定事件(移除冗余 keydown 处理,交由浏览器原生换行)
editor.addEventListener("input", highlightKeywords);

// 可选:防抖优化(高频输入时不卡顿)
// const debouncedHighlight = debounce(highlightKeywords, 100);
// editor.addEventListener("input", debouncedHighlight);
</script>

⚠️ 注意事项与进阶建议

  • innerText vs textContent:innerText 会忽略不可见元素(如 <script>)、受 CSS 影响(如 display:none),但在 contenteditable 场景中更贴近用户视觉编辑体验;若需严格原始文本,请改用 textContent 并自行处理换行符( → <br>)。
  • 性能考量:全量高亮对长文本开销较大。生产环境建议:
    • 仅高亮当前可视区域(viewport)内内容;
    • 使用 MutationObserver 替代 input 事件,捕获真实 DOM 变化;
    • 对关键词匹配做前缀树(Trie)优化。
  • Enter 键处理:原 keydown 中手动插入 <br> 易引发嵌套问题。推荐使用 CSS white-space: pre-wrap 配合浏览器原生换行行为,更稳定。
  • 特殊字符兼容性:若需支持 '、" 等符号不跳动,应在正则中排除字符串字面量(需词法分析,非简单正则可覆盖);此时建议引入轻量解析器(如 acorn 或自定义状态机)。

该方案已在 Firefox 最新版验证通过,兼顾准确性与健壮性,是构建轻量级在线代码编辑器的实用起点。

热门AI工具

更多
VibeKnow
VibeKnow Hot

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

DeepSeek

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

WorkBuddy

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

AionClaw
AionClaw Hot

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

豆包大模型

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

相关专题

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

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

5106

2023.06.20

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

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

1249

2023.07.04

js四舍五入
js四舍五入

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

5044

2023.07.04

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

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

980

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1896

2023.09.04

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

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

3585

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4673

2023.09.12

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

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

3060

2023.09.20

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
JavaScript OOP调试技巧视频教程
JavaScript OOP调试技巧视频教程

共5课时 | 1.1万人学习

jQuery官方API文档
jQuery官方API文档

共0课时 | 0人学习

JavaScript 编程技巧与实战
JavaScript 编程技巧与实战

共103课时 | 15.7万人学习

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

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