[js] VSCode 同款的光标历史记录来了!

先看效果:

光标的历史记录会保存下来(默认 10 条历史),按下 Alt+← 可以跳转到上个标签,按下 Alt+→ 可以跳转到下个标签

请先把思源自带的 Alt←→ 跳转至上一级下一级的快捷键禁用掉

适合做题或者回顾笔记时,想编辑很靠上边的文本,编辑完之后想回到刚才的位置,这样就不用来回用鼠标滚来滚去了

已知 bug:

  • 没办法跨文档滚动(似乎无法解决,因为 siyuan 的 dom 就是这样的)
  • 光标回复位置成功,但是移出了视线,再按两下左右键就能让屏幕看到那了
// 光标历史记录管理器
class CursorHistory {
  constructor(maxLength = 10) {
    this.history = []; // 存储光标历史
    this.currentIndex = -1; // 当前历史索引
    this.maxLength = maxLength; // 最大记录数
    this.isNavigating = false; // 标记是否通过快捷键导航
    this.init();
  }

  // 初始化:监听可编辑元素和快捷键
  init() {
    this.observeEditableElements();
    this.listenKeyEvents();
  }

  // 监听所有可编辑元素(适配含嵌套结构的场景)
  observeEditableElements() {
    // 选择所有真正可编辑的元素(contenteditable="true")
    const editableSelector = '[contenteditable="true"]';
  
    // 监听鼠标点击(记录光标位置)
    document.addEventListener('mouseup', (e) => {
      const target = e.target.closest(editableSelector);
      if (target) {
        this.handleCursorChange(target);
      }
    });

    // 监听键盘输入(记录光标移动)
    document.addEventListener('keyup', (e) => {
      // 排除导航快捷键本身
      if (e.altKey && (e.key === 'ArrowLeft' || e.key === 'ArrowRight')) return;
    
      const target = e.target.closest(editableSelector);
      if (target) {
        this.handleCursorChange(target);
      }
    });

    // 监听焦点离开(记录最终位置)
    document.addEventListener('blur', (e) => {
      const target = e.target.closest(editableSelector);
      if (target) {
        this.handleCursorChange(target);
      }
    }, true); // 捕获阶段监听,确保嵌套元素也能触发
  }

  // 处理光标位置变化(统一记录逻辑)
  handleCursorChange(editableElement) {
    // 导航产生的位置不记录
    if (this.isNavigating) {
      this.isNavigating = false;
      return;
    }

    const selection = window.getSelection();
    if (selection.rangeCount === 0) return;

    const range = selection.getRangeAt(0);
    // 验证光标是否在当前可编辑元素内
    if (!editableElement.contains(range.commonAncestorContainer)) return;

    // 记录详细位置信息(含嵌套节点)
    const position = {
      parentNodeId: editableElement.closest('[data-node-id]').dataset.nodeId, // 父节点唯一ID
      container: range.startContainer, // 光标所在的具体节点(可能是span等)
      startOffset: range.startOffset, // 起始偏移量
      endOffset: range.endOffset, // 结束偏移量(用于选择范围)
      editableElement: editableElement // 可编辑元素本身
    };

    // 避免连续重复记录
    const last = this.history[this.history.length - 1];
    if (this.isDuplicate(last, position)) return;

    // 截断历史分支(如果不在最新位置)
    if (this.currentIndex < this.history.length - 1) {
      this.history = this.history.slice(0, this.currentIndex + 1);
    }

    // 添加新记录并维护长度
    this.history.push(position);
    this.currentIndex = this.history.length - 1;
    if (this.history.length > this.maxLength) {
      this.history.shift();
      this.currentIndex--;
    }

    this.updateDebugInfo(); // 可选:更新调试信息
  }

  // 判断两个位置是否重复
  isDuplicate(last, current) {
    if (!last) return false;
    // 比较父节点ID、容器节点和偏移量
    return (last.parentNodeId === current.parentNodeId &&
            last.container === current.container &&
            last.startOffset === current.startOffset &&
            last.endOffset === current.endOffset);
  }

  // 回退到上一个位置
  goBack() {
    if (this.currentIndex > 0) {
      this.isNavigating = true;
      this.currentIndex--;
      this.restorePosition();
    }
  }

  // 前进到下一个位置
  goForward() {
    if (this.currentIndex < this.history.length - 1) {
      this.isNavigating = true;
      this.currentIndex++;
      this.restorePosition();
    }
  }

  // 恢复光标位置(处理嵌套节点)
  restorePosition() {
    const position = this.history[this.currentIndex];
    if (!position) return;

    try {
      // 聚焦到对应的可编辑元素
      position.editableElement.focus();

      // 恢复选择范围
      const selection = window.getSelection();
      const range = document.createRange();
    
      // 处理可能的节点变化(如果原节点已不存在,降级到父元素)
      const validContainer = this.isNodeValid(position.container, position.editableElement) 
        ? position.container 
        : position.editableElement.firstChild || position.editableElement;

      range.setStart(validContainer, position.startOffset);
      range.setEnd(validContainer, position.endOffset);
      selection.removeAllRanges();
      selection.addRange(range);
    } catch (e) {
      console.warn('恢复光标位置失败:', e);
    }

    this.updateDebugInfo(); // 可选:更新调试信息
  }

  // 验证节点是否仍有效(避免DOM变动后引用失效)
  isNodeValid(container, editableElement) {
    return container && editableElement.contains(container);
  }

  // 监听快捷键(Alt+左/右箭头)
  listenKeyEvents() {
    document.addEventListener('keydown', (e) => {
      if (e.altKey) {
        if (e.key === 'ArrowLeft') {
          e.preventDefault();
          this.goBack();
        } else if (e.key === 'ArrowRight') {
          e.preventDefault();
          this.goForward();
        }
      }
    });
  }

  // 可选:更新调试信息(可根据需要删除)
  updateDebugInfo() {
    // 若需要在控制台显示历史记录状态
    console.log(`光标历史: ${this.history.length}/${this.maxLength} 条,当前索引: ${this.currentIndex}`);
  }
}

// 初始化功能
(() => {
  // 可配置最大历史记录数(默认10条)
  window.cursorHistory = new CursorHistory(10);
  console.log('光标历史功能已启动,使用 Alt+左箭头 回退,Alt+右箭头 前进');
})();
  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统,支持完全离线使用,同时也支持端到端加密同步。

    融合块、大纲和双向链接,重构你的思维。

    28446 引用 • 119790 回帖
  • 代码片段

    代码片段分为 CSS 与 JS 两种代码,添加在 [设置 - 外观 - 代码片段] 中,这些代码会在思源笔记加载时自动执行,用于改善笔记的样式或功能。

    用户在该标签下分享代码片段时需在帖子标题前添加 [css] [js] 用于区分代码片段类型。

    285 引用 • 1988 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • iOS

    iOS 是由苹果公司开发的移动操作系统,最早于 2007 年 1 月 9 日的 Macworld 大会上公布这个系统,最初是设计给 iPhone 使用的,后来陆续套用到 iPod touch、iPad 以及 Apple TV 等产品上。iOS 与苹果的 Mac OS X 操作系统一样,属于类 Unix 的商业操作系统。

    89 引用 • 150 回帖 • 1 关注
  • MySQL

    MySQL 是一个关系型数据库管理系统,由瑞典 MySQL AB 公司开发,目前属于 Oracle 公司。MySQL 是最流行的关系型数据库管理系统之一。

    695 引用 • 538 回帖 • 1 关注
  • Notion

    Notion - The all-in-one workspace for your notes, tasks, wikis, and databases.

    10 引用 • 80 回帖
  • JavaScript

    JavaScript 一种动态类型、弱类型、基于原型的直译式脚本语言,内置支持类型。它的解释器被称为 JavaScript 引擎,为浏览器的一部分,广泛用于客户端的脚本语言,最早是在 HTML 网页上使用,用来给 HTML 网页增加动态功能。

    736 引用 • 1307 回帖 • 2 关注
  • SOHO

    为成为自由职业者在家办公而努力吧!

    7 引用 • 55 回帖 • 1 关注
  • RIP

    愿逝者安息!

    8 引用 • 92 回帖 • 429 关注
  • FlowUs

    FlowUs.息流 个人及团队的新一代生产力工具。

    让复杂的信息管理更轻松、自由、充满创意。

    1 引用 • 1 关注
  • Windows

    Microsoft Windows 是美国微软公司研发的一套操作系统,它问世于 1985 年,起初仅仅是 Microsoft-DOS 模拟环境,后续的系统版本由于微软不断的更新升级,不但易用,也慢慢的成为家家户户人们最喜爱的操作系统。

    232 引用 • 484 回帖
  • 强迫症

    强迫症(OCD)属于焦虑障碍的一种类型,是一组以强迫思维和强迫行为为主要临床表现的神经精神疾病,其特点为有意识的强迫和反强迫并存,一些毫无意义、甚至违背自己意愿的想法或冲动反反复复侵入患者的日常生活。

    15 引用 • 161 回帖 • 1 关注
  • 前端

    前端技术一般分为前端设计和前端开发,前端设计可以理解为网站的视觉设计,前端开发则是网站的前台代码实现,包括 HTML、CSS 以及 JavaScript 等。

    248 引用 • 1342 回帖
  • Swagger

    Swagger 是一款非常流行的 API 开发工具,它遵循 OpenAPI Specification(这是一种通用的、和编程语言无关的 API 描述规范)。Swagger 贯穿整个 API 生命周期,如 API 的设计、编写文档、测试和部署。

    26 引用 • 35 回帖 • 16 关注
  • Sym

    Sym 是一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)系统平台。

    下一代的社区系统,为未来而构建

    524 引用 • 4602 回帖 • 731 关注
  • IDEA

    IDEA 全称 IntelliJ IDEA,是一款 Java 语言开发的集成环境,在业界被公认为最好的 Java 开发工具之一。IDEA 是 JetBrains 公司的产品,这家公司总部位于捷克共和国的首都布拉格,开发人员以严谨著称的东欧程序员为主。

    182 引用 • 400 回帖 • 1 关注
  • 创业

    你比 99% 的人都优秀么?

    81 引用 • 1396 回帖
  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统,支持完全离线使用,同时也支持端到端加密同步。

    融合块、大纲和双向链接,重构你的思维。

    28446 引用 • 119790 回帖
  • Linux

    Linux 是一套免费使用和自由传播的类 Unix 操作系统,是一个基于 POSIX 和 Unix 的多用户、多任务、支持多线程和多 CPU 的操作系统。它能运行主要的 Unix 工具软件、应用程序和网络协议,并支持 32 位和 64 位硬件。Linux 继承了 Unix 以网络为核心的设计思想,是一个性能稳定的多用户网络操作系统。

    960 引用 • 946 回帖
  • AWS
    11 引用 • 28 回帖 • 1 关注
  • 小说

    小说是以刻画人物形象为中心,通过完整的故事情节和环境描写来反映社会生活的文学体裁。

    33 引用 • 108 回帖
  • frp

    frp 是一个可用于内网穿透的高性能的反向代理应用,支持 TCP、UDP、 HTTP 和 HTTPS 协议。

    17 引用 • 7 回帖 • 1 关注
  • JSON

    JSON (JavaScript Object Notation)是一种轻量级的数据交换格式。易于人类阅读和编写。同时也易于机器解析和生成。

    54 引用 • 190 回帖
  • 链滴

    链滴是一个记录生活的地方。

    记录生活,连接点滴

    203 引用 • 4025 回帖
  • 996
    13 引用 • 200 回帖 • 6 关注
  • Redis

    Redis 是一个开源的使用 ANSI C 语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value 数据库,并提供多种语言的 API。从 2010 年 3 月 15 日起,Redis 的开发工作由 VMware 主持。从 2013 年 5 月开始,Redis 的开发由 Pivotal 赞助。

    285 引用 • 248 回帖 • 2 关注
  • OneNote
    2 引用 • 5 回帖
  • API

    应用程序编程接口(Application Programming Interface)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

    79 引用 • 431 回帖 • 1 关注
  • HHKB

    HHKB 是富士通的 Happy Hacking 系列电容键盘。电容键盘即无接点静电电容式键盘(Capacitive Keyboard)。

    5 引用 • 74 回帖 • 548 关注
  • 职场

    找到自己的位置,萌新烦恼少。

    127 引用 • 1708 回帖 • 1 关注