首页
/ BlockNote v0.29.0版本发布:新增变更事件与事务API

BlockNote v0.29.0版本发布:新增变更事件与事务API

2025-06-07 10:49:01作者:田桥桑Industrious

BlockNote是一个现代化的富文本编辑器框架,基于ProseMirror构建,提供了丰富的块状编辑体验。它允许开发者轻松创建类似Notion的编辑器界面,支持自定义块类型、实时协作等功能。本次发布的v0.29.0版本带来了两项重要的新功能:变更事件监听和事务API,为开发者提供了更强大的编辑器控制能力。

变更事件(change event)

新版本引入了change事件API,这是一个重要的增强功能,它允许开发者精确追踪编辑器内容的变化。通过注册onChange回调,现在可以获取到被插入、更新或删除的块列表。

这项功能的实际应用场景非常广泛:

  • 实现精确的撤销/重做功能
  • 构建实时协作系统中的增量更新
  • 开发基于内容变化的自动保存机制
  • 创建内容变更审计日志

在底层实现上,这个API通过分析ProseMirror的事务(transaction)来识别内容变化,然后将这些变化映射到BlockNote的块模型上,为开发者提供了更高层次的抽象。

事务API(transact API)

v0.29.0版本引入了一个重要的底层API——transactAPI,这是与ProseMirror状态交互的新方式。这个API实现了BlockNote级别的事务处理,意味着多个操作可以共享同一个事务,最终只产生一个撤销/重做步骤。

事务API的主要特点包括:

  • 原子性操作:多个编辑动作可以组合成一个原子操作
  • 撤销/重做友好:相关操作会被视为一个整体进行撤销或重做
  • 性能优化:减少不必要的事务处理开销

配套提供的还有两个辅助API:

  • exec:执行ProseMirror命令
  • canExec:检查ProseMirror命令是否可以执行

这些API共同构成了BlockNote与现有ProseMirror命令之间的桥梁,为开发者提供了更大的灵活性。

其他改进与修复

除了上述主要功能外,本次更新还包括了一些重要的改进和错误修复:

  1. 现在允许在已打开一个建议菜单的情况下触发另一个建议菜单,解决了之前存在的交互限制问题。

  2. 在schema中增加了引用的支持,为后续功能扩展奠定了基础。

  3. 更新了y-prosemirror依赖,修复了协作编辑中的一些问题。

  4. 改进了建议菜单的事务处理机制,现在会作为独立的事务进行分发,提高了编辑器的稳定性。

技术影响与最佳实践

对于开发者来说,这些新API的引入意味着可以构建更加健壮和功能丰富的编辑器应用。以下是一些建议的最佳实践:

  1. 当需要精确追踪内容变化时,优先使用新的change事件而不是简单的内容比较。

  2. 对于复杂的编辑操作序列,使用transactAPI将它们包装成单个事务,既能提高性能又能改善用户体验。

  3. 在开发自定义块或扩展功能时,考虑使用execcanExecAPI来与现有的ProseMirror生态系统集成。

BlockNote v0.29.0的这些改进展示了项目向更成熟、更强大的编辑器框架发展的方向,为开发者提供了更多底层控制能力,同时保持了高层次的易用性。

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