首页
/ 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 状态管理机制提供了有价值的参考。

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
595
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K