首页
/ Tiptap Vue 3 中 BubbleMenu 的 shouldShow 回调问题解析与解决方案

Tiptap Vue 3 中 BubbleMenu 的 shouldShow 回调问题解析与解决方案

2025-05-05 23:04:56作者:伍霜盼Ellen

问题背景

在 Tiptap Vue 3 项目中,开发者在使用 BubbleMenu 扩展时遇到了一个关于 shouldShow 回调函数的异常行为。具体表现为当使用 editor.isActive 方法作为条件判断时,返回的状态值不符合预期,导致气泡菜单的显示逻辑出现延迟或错误。

问题现象

当开发者在 shouldShow 回调中使用类似 editor.isActive('bold') 的条件时,首次点击已加粗的文本时,回调函数返回的 isActive 值为 false,而只有在第二次点击时才会返回正确的 true 值。这种状态延迟使得气泡菜单无法在正确时机显示。

根本原因分析

经过深入研究发现,问题根源在于 Vue 3 实现中的 reactiveState 属性。在 BubbleMenu 插件调用 shouldShow 回调时,reactiveState 尚未完成更新,导致获取的编辑器状态是过时的。虽然最初怀疑与 requestAnimationFrame 相关的防抖机制有关,但禁用相关调用后问题依然存在,这表明问题更可能与 Vue 3 的响应式系统更新时序有关。

解决方案

直接使用视图状态

最有效的解决方案是绕过 editor.isActive 方法,直接从编辑器的视图状态获取当前激活状态:

import { isMarkActive } from '@tiptap/core';

const shouldShowBubbleMenu = ({ editor }) => {
    return isMarkActive(editor.view.state, 'link');
};

这种方法利用了 editor.view.state,该状态在回调时总是最新的,避免了响应式状态延迟的问题。

文本选择判断的适配方案

对于需要判断文本是否被选中的场景,可以类似地直接从视图状态获取信息:

function isTextSelected({ editor }) {
  const {
    state: {
      doc,
      selection,
      selection: { empty, from, to },
    },
  } = editor.view;

  const isEmptyTextBlock = !doc.textBetween(from, to).length && isTextSelection(selection);

  if (empty || isEmptyTextBlock || !editor.isEditable)
    return false;

  return true;
}

技术原理

Tiptap 在 Vue 3 实现中使用了响应式系统来管理编辑器状态,这导致了状态更新的异步特性。而 BubbleMenu 插件在判断显示条件时,需要同步获取最新状态。通过直接访问 editor.view.state,我们绕过了响应式系统的延迟,获取了即时的编辑器状态。

适用场景

该解决方案适用于:

  1. Vue 3 项目中使用 Tiptap 的 BubbleMenu 扩展
  2. 需要基于编辑器状态动态显示/隐藏气泡菜单的场景
  3. 使用 isActive 或其他状态相关方法作为显示条件的实现

注意事项

  1. 此问题主要存在于 Vue 3 实现中,React 和纯 JavaScript 实现不受影响
  2. 解决方案同样适用于其他需要即时状态判断的场景
  3. 对于节点激活状态的判断,可以使用 isNodeActive 替代 isMarkActive

总结

通过直接访问编辑器视图状态而非依赖响应式状态,开发者可以解决 Tiptap Vue 3 中 BubbleMenu 显示条件的时序问题。这种方案不仅解决了当前问题,也为理解 Tiptap 状态管理机制提供了有价值的参考。

登录后查看全文
热门项目推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
927
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8