在 Input 和 Textarea 光标处添加字符串

在 Web 开发中，有时我们需要在用户的输入框（<input> 或 <textarea>）中的光标位置插入文本，而不仅仅是简单地替换整个输入框的内容。这种功能常见于富文本编辑器、聊天应用或任何需要在用户输入过程中进行交互的应用场景。本文将详细介绍如何实现这一功能，包括基本概念、使用方法、代码示例以及一些最佳实践。

基本概念

插入点

在文本输入框中，插入点指的是用户光标所在的位置。通常情况下，当我们在输入框内输入文本时，新字符会被插入到这个位置。

作用说明

• 富文本编辑器：在用户正在编辑的段落中插入新的内容。
• 聊天应用：自动完成用户名或表情符号等。
• 代码编辑器：提供代码补全功能。

技术实现

为了在光标位置插入文本，我们需要获取光标的位置，然后根据该位置分割原始文本，插入新文本，最后重新拼接文本。接下来，我们将逐步讲解如何实现这一过程。

示例一：基本用法

function insertAtCursor(element, textToInsert) {
  // 获取当前光标位置
  const cursorPosition = element.selectionStart;
  
  // 获取光标前后的文本
  const startText = element.value.substring(0, cursorPosition);
  const endText = element.value.substring(cursorPosition);
  
  // 插入文本
  element.value = startText + textToInsert + endText;
  
  // 设置光标位置
  element.setSelectionRange(cursorPosition + textToInsert.length, cursorPosition + textToInsert.length);
}

示例二：使用 input 元素

<input type="text" id="myInput" />
<button onclick="insertTextAtCursor(document.getElementById('myInput'), 'Hello, ');">Insert Text</button>

function insertTextAtCursor(inputElement, textToInsert) {
  const cursorPosition = inputElement.selectionStart;
  const startText = inputElement.value.substring(0, cursorPosition);
  const endText = inputElement.value.substring(cursorPosition);
  inputElement.value = startText + textToInsert + endText;
  inputElement.setSelectionRange(cursorPosition + textToInsert.length, cursorPosition + textToInsert.length);
}

示例三：使用 textarea 元素

<textarea id="myTextarea"></textarea>
<button onclick="insertTextAtCursor(document.getElementById('myTextarea'), 'World!');">Insert Text</button>

function insertTextAtCursor(textareaElement, textToInsert) {
  const cursorPosition = textareaElement.selectionStart;
  const startText = textareaElement.value.substring(0, cursorPosition);
  const endText = textareaElement.value.substring(cursorPosition);
  textareaElement.value = startText + textToInsert + endText;
  textareaElement.setSelectionRange(cursorPosition + textToInsert.length, cursorPosition + textToInsert.length);
}

示例四：考虑换行符

对于 <textarea> 元素，我们还需要考虑换行符的影响。当光标位于新的一行开始时，插入的文本不应该破坏原有的换行结构。

function insertTextAtCursor(textareaElement, textToInsert) {
  const cursorPosition = textareaElement.selectionStart;
  const startText = textareaElement.value.substring(0, cursorPosition);
  const endText = textareaElement.value.substring(cursorPosition);
  
  // 处理换行符
  const newline = /\r\n|\n/g;
  let startTextWithNewline = startText.replace(newline, '\n');
  let endTextWithNewline = endText.replace(newline, '\n');
  
  textareaElement.value = startTextWithNewline + textToInsert + endTextWithNewline;
  textareaElement.setSelectionRange(cursorPosition + textToInsert.length, cursorPosition + textToInsert.length);
}

示例五：使用 Composition API

对于 Vue.js 或其他使用 Composition API 的框架，可以封装一个组合式函数来处理插入操作。

import { ref } from 'vue';

export default function useInsertAtCursor() {
  const inputRef = ref(null);

  function handleInsert(textToInsert) {
    const cursorPosition = inputRef.value.selectionStart;
    const startText = inputRef.value.value.substring(0, cursorPosition);
    const endText = inputRef.value.value.substring(cursorPosition);
    
    inputRef.value.value = startText + textToInsert + endText;
    inputRef.value.setSelectionRange(cursorPosition + textToInsert.length, cursorPosition + textToInsert.length);
  }

  return {
    inputRef,
    handleInsert,
  };
}

不同角度的功能使用思路

角度一：自动完成

• 使用场景：当用户开始键入用户名时，自动完成建议。
• 代码示例：

document.getElementById('myInput').addEventListener('keyup', function(event) {
  const input = this;
  const userInput = input.value.trim().toLowerCase();
  const suggestions = getSuggestions(userInput); // 获取建议列表
  if (suggestions.length > 0) {
    insertTextAtCursor(input, suggestions[0]);
  }
});

角度二：代码高亮编辑器

• 使用场景：在代码编辑器中插入关键词或函数名。
• 代码示例：

function insertCodeKeyword(textarea, keyword) {
  insertTextAtCursor(textarea, keyword);
  // 更新代码高亮
  updateCodeHighlighting(textarea);
}

角度三：聊天应用

• 使用场景：在聊天消息中插入表情符号或用户名。
• 代码示例：

document.getElementById('chatInput').addEventListener('keyup', function(event) {
  if (event.key === '@') {
    event.preventDefault();
    insertTextAtCursor(this, '@username ');
  }
});

角度四：富文本编辑器

• 使用场景：在富文本编辑器中插入格式化标签。
• 代码示例：

function insertFormattedText(textarea, formatTag) {
  insertTextAtCursor(textarea, `<${formatTag}>`);
  // 调整光标位置
  textarea.setSelectionRange(textarea.selectionStart + 2, textarea.selectionStart + 2);
}

实际工作中的使用技巧

1. 兼容性：确保你的实现能够在不同的浏览器版本上正常运行，特别是在移动设备上。
2. 性能考量：对于大型的 <textarea> 或 <input>，频繁的操作可能会导致性能下降，可以考虑使用批量更新或异步更新机制。
3. 用户体验：提供撤销功能，让用户可以撤销意外的插入操作。
4. 辅助功能：确保你的实现对屏幕阅读器友好，便于视力障碍人士使用。
5. 安全考量：在插入文本之前对用户输入进行适当的清理，防止 XSS 攻击。

结合经验分析

在实际项目中，实现这样的功能需要仔细考虑多种因素。例如，在聊天应用中，我们可能会在用户键入 “@” 符号时触发自动完成建议，这时候需要确保插入的文本不会破坏现有的输入流。此外，还需要考虑到用户可能希望在插入文本后继续键入，因此设置正确的光标位置至关重要。

对于富文本编辑器来说，插入格式化的文本时，我们可能需要考虑如何保持光标位置不变，或者如何处理嵌套的标签。这通常涉及到更多的逻辑判断和状态管理。

综上所述，虽然在 <input> 和 <textarea> 中插入文本看似简单，但要实现一个高效、稳定且用户友好的解决方案，则需要细致的设计和实现。通过以上的介绍和示例，希望能够帮助你在实际工作中更好地应对这类需求。

---

欢迎来到我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。

---

推荐：DTcode7的博客首页。
一个做过前端开发的产品经理，经历过睿智产品的折磨导致脱发之后，励志要翻身农奴把歌唱，一边打入敌人内部一边持续提升自己，为我们广大开发同胞谋福祉，坚决抵制睿智产品折磨我们码农兄弟！

---

专栏系列（点击解锁）	学习路线(点击解锁）	知识定位
《微信小程序相关博客》	持续更新中~	结合微信官方原生框架、uniapp等小程序框架，记录请求、封装、tabbar、UI组件的学习记录和使用技巧等
《AIGC相关博客》	持续更新中~	AIGC、AI生产力工具的介绍，例如stable diffusion这种的AI绘画工具安装、使用、技巧等总结
《HTML网站开发相关》	《前端基础入门三大核心之html相关博客》	前端基础入门三大核心之html板块的内容，入坑前端或者辅助学习的必看知识
	《前端基础入门三大核心之JS相关博客》	前端JS是JavaScript语言在网页开发中的应用，负责实现交互效果和动态内容。它与HTML和CSS并称前端三剑客，共同构建用户界面。 通过操作DOM元素、响应事件、发起网络请求等，JS使页面能够响应用户行为，实现数据动态展示和页面流畅跳转，是现代Web开发的核心
	《前端基础入门三大核心之CSS相关博客》	介绍前端开发中遇到的CSS疑问和各种奇妙的CSS语法，同时收集精美的CSS效果代码，用来丰富你的web网页
	《canvas绘图相关博客》	Canvas是HTML5中用于绘制图形的元素，通过JavaScript及其提供的绘图API，开发者可以在网页上绘制出各种复杂的图形、动画和图像效果。Canvas提供了高度的灵活性和控制力，使得前端绘图技术更加丰富和多样化
《Vue实战相关博客》	持续更新中~	详细总结了常用UI库elementUI的使用技巧以及Vue的学习之旅
《python相关博客》	持续更新中~	Python，简洁易学的编程语言，强大到足以应对各种应用场景，是编程新手的理想选择，也是专业人士的得力工具
《sql数据库相关博客》	持续更新中~	SQL数据库：高效管理数据的利器，学会SQL，轻松驾驭结构化数据，解锁数据分析与挖掘的无限可能
《算法系列相关博客》	持续更新中~	算法与数据结构学习总结，通过JS来编写处理复杂有趣的算法问题，提升你的技术思维
《IT信息技术相关博客》	持续更新中~	作为信息化人员所需要掌握的底层技术，涉及软件开发、网络建设、系统维护等领域的知识
	《信息化人员基础技能知识相关博客》	无论你是开发、产品、实施、经理，只要是从事信息化相关行业的人员，都应该掌握这些信息化的基础知识，可以不精通但是一定要了解，避免日常工作中贻笑大方
	《信息化技能面试宝典相关博客》	涉及信息化相关工作基础知识和面试技巧，提升自我能力与面试通过率，扩展知识面
《前端开发习惯与小技巧相关博客》	持续更新中~	罗列常用的开发工具使用技巧,如 Vscode快捷键操作、Git、CMD、游览器控制台等
《photoshop相关博客》	持续更新中~	基础的PS学习记录，含括PPI与DPI、物理像素dp、逻辑像素dip、矢量图和位图以及帧动画等的学习总结
日常开发&办公&生产【实用工具】分享相关博客》	持续更新中~	分享介绍各种开发中、工作中、个人生产以及学习上的工具，丰富阅历，给大家提供处理事情的更多角度，学习了解更多的便利工具，如Fiddler抓包、办公快捷键、虚拟机VMware等工具

吾辈才疏学浅，摹写之作，恐有瑕疵。望诸君海涵赐教。望轻喷，嘤嘤嘤
非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。愿斯文对汝有所裨益，纵其简陋未及渊博，亦足以略尽绵薄之力。倘若尚存阙漏，敬请不吝斧正，俾便精进！