【知识归纳】浏览器光标及选区的获取和设置

本文已收录至博客《前端从入门到入土》,欢迎点赞、收藏 + 关注~

在使用 InputTextarea 的场景中,经常需要获取光标的位置或选择范围,以及设置光标的位置或选择范围。

获取光标位置

光标位置分为两种,数据层面的 Range,处于屏幕中的实际位置的 Position。我们先来说一下 Range

Range对象表示页面上的一个连续的文本范围或者一个节点范围。它包含了起始节点和结束节点,以及这两个节点之间的文本内容。

Range对象的数据结构如下所示:

typescript 复制代码
{
    startContainer: Node, // 范围的起始节点
    startOffset: number, // 范围在起始节点中的偏移量
    endContainer: Node, // 范围的结束节点
    endOffset: number, // 范围在结束节点中的偏移量
    commonAncestorContainer: Node // 范围的公共祖先节点
}

其中,startContainerendContainer 表示范围的起始节点和结束节点,可以是文本节点、元素节点等。startOffset endOffset 表示范围在起始节点和结束节点中的偏移量,即范围的起始位置和结束位置。commonAncestorContainer 表示范围的公共祖先节点,即起始节点和结束节点的最近共同父节点。

通过这些属性,可以对 Range 进行进一步的操作和处理,例如获取范围内的文本内容、插入新的节点等。

获取 Range

获取 Range 可以通过如下方法

js 复制代码
let selection = window.getSelection();
// 或者使用 let selection = document.getSelection();
if (selection.rangeCount > 0) {
  let range = selection.getRangeAt(0);
  // other code
}

获取选中的文本

js 复制代码
let range = selection.getRangeAt(0);
let textContent = range.toString();
console.log(textContent);

获取光标或选区位置

有时候我们希望获取光标或选区在屏幕中的位置,来做一些定位或特殊处理,可以在得到 Range 后,调用getBoundingClientRect来获取定位。

定位信息rect包含光标或选区在屏幕中的绝对定位。

js 复制代码
let range = selection.getRangeAt(0);
let rect = range.getBoundingClientRect();
console.log(rect);

如果我们希望能相对某个父元素进行定位,则同步调用父元素的dom.getBoundingClientRect,得到rect2,将两个值对应的定位信息相减,就能得到相对位置。

通过点击位置获取 Range

有时候我们可能希望通过点击位置获取一下点击后光标的位置。有两种方法可以实现。

  1. 遍历点击位置的元素,逐个查找哪个位置离点击位置最近。这里不详细讲解。
  2. 通过浏览器自带能力

当我们点击一个位置,在对应的 event 中,我们可以获取到点击位置的{x, y},此时可以调用下面的脚本,来获取Range

js 复制代码
if (document.caretRangeFromPoint) {
  domRange = document.caretRangeFromPoint(x, y);
} else {
  // @ts-ignore
  const position = document.caretPositionFromPoint(x, y);

  if (position) {
    domRange = document.createRange();
    domRange.setStart(position.offsetNode, position.offset);
    domRange.setEnd(position.offsetNode, position.offset);
  }
}

设置光标或选区

如果是<input><textarea>等可编辑元素,可以直接使用setSelectionRange

js 复制代码
let inputElement = document.getElementById('inputId');
let position = inputElement.value.length - 1; // 倒数第二个位置
inputElement.setSelectionRange(position, position);

如果不是<input><textarea>等可编辑元素,可以使用document.createRange()方法来创建一个Range对象,然后使用range.setStart()range.setEnd()方法来设置选区的起始和结束位置。最后,使用window.getSelection()方法获取当前的选区对象,并使用selection.removeAllRanges()方法清除之前的选区,再使用selection.addRange()方法将创建的Range对象添加到选区中,从而使选区生效。

js 复制代码
// 创建 Range 对象
let range = document.createRange();

// 设置 Range 对象的起始和结束位置
let startNode = document.getElementById('startNode');
let endNode = document.getElementById('endNode');
range.setStart(startNode, 0); // 设置起始位置,此处假设起始位置是节点的第一个字符
range.setEnd(endNode, 1); // 设置结束位置,此处假设结束位置是节点的第二个字符

// 获取当前的选区对象并添加 Range 对象
let selection = window.getSelection();
selection.removeAllRanges(); // 清除之前的选区
selection.addRange(range);

参考文档

  • GPT问答
相关推荐
anOnion8 小时前
构建无障碍组件之Menu Button pattern
前端·html·交互设计
JieE2129 小时前
LeetCode 101. 对称二叉树|JS 递归 + 迭代双解法,彻底搞懂镜像判断
javascript·算法
冬奇Lab11 小时前
AI Workflow 定义的四次演进:从 Markdown 到 JS 脚本,再到分布式多 Agent
javascript·人工智能·agent
一颗烂土豆17 小时前
Meshopt 压缩深度解析,为什么它比 Draco 更快
前端·javascript·webgl
kyriewen19 小时前
同事每天催我 Code Review,我写了个脚本让 AI 替我 review PR——现在他反过来催 AI 了
前端·javascript·ai编程
米丘1 天前
微前端之 Web Components 完全指南
微服务·html
weedsfly1 天前
迭代器、生成器与异步迭代——让数据“按需流动”的艺术
前端·javascript
假如让我当三天老蒯1 天前
前端跨域解决方案(学习用)
前端·javascript·面试
铁皮饭盒1 天前
Bun 哪比 Node.js 快?
javascript·后端
JieE2121 天前
LeetCode 56. 合并区间|超清晰 JS 图解思路,面试高频区间题
javascript·算法·面试