BlockNote项目中自定义行内组件导出值的实现方案
2025-05-29 17:21:07作者:庞眉杨Will
BlockNote
A "Notion-style" block-based extensible text editor built on top of Prosemirror and Tiptap.
在基于BlockNote编辑器进行二次开发时,开发者经常需要实现自定义的行内组件,并控制其导出格式。本文将以实现一个@mention功能为例,深入讲解如何通过createReactInlineContentSpec创建自定义组件,并实现渲染内容与导出内容的差异化处理。
核心需求分析
在实际业务场景中,我们通常需要:
- 在编辑器中显示友好的用户标识(如@username)
- 导出时转换为特定的数据格式(如)
- 保持编辑体验与数据存储的分离
技术实现详解
1. 创建自定义Mention组件
通过createReactInlineContentSpec定义组件规范:
const Mention = createReactInlineContentSpec({
type: "mention",
propSchema: {
path: { default: "No path" }, // 显示用名称
data: { default: "No data" } // 实际存储数据
},
content: "none"
}, {
render: ({ inlineContent }) => (
<span style={{ backgroundColor: "#8400ff33" }}>
@{inlineContent.props.path}
</span>
)
});
关键点说明:
- propSchema定义了两个属性:path用于显示,data用于存储
- content设置为"none"表示这是不可编辑的原子组件
- render方法控制可视化呈现,这里添加了背景色突出显示
2. 自定义Markdown导出逻辑
BlockNote默认的blocksToMarkdownLossy可能无法满足定制需求,需要手动实现转换:
const customExporter = (blocks) => blocks.reduce((acc, block) => {
let content = "";
// 处理标题块
if (block.type === "heading") {
content += "#".repeat(block.props.level) + " ";
}
// 处理行内内容
content += block.content?.reduce((str, inline) => {
if (inline.type === "text") return str + inline.text;
if (inline.type === "mention") return str + `<${inline.props.data}>`;
return str;
}, "") || "";
return acc + content + "\n\n";
}, "");
转换逻辑特点:
- 保持标题的Markdown语法(#号数量对应级别)
- 普通文本直接输出
- Mention组件转换为格式
- 添加适当的换行保证可读性
高级应用场景
双向转换处理
完整的解决方案还应考虑从Markdown导入时的逆向转换:
- 解析格式的标记
- 查询用户系统获取显示名称
- 重新构建为Mention组件
性能优化建议
对于大型文档:
- 使用memoization缓存转换结果
- 实现增量导出机制
- 考虑Web Worker处理耗时操作
总结
BlockNote的灵活架构允许开发者通过createReactInlineContentSpec深度定制行内组件。通过分离显示属性(path)和数据属性(data),我们可以实现编辑时友好显示与导出时规范格式的统一。自定义导出逻辑时需要注意保持Markdown的语法规范,同时确保特殊标记的可逆转换。
这种模式不仅适用于@mention功能,还可以扩展到各种需要特殊渲染和存储的业务场景,如商品链接、文档引用等复杂元素的处理。
BlockNote
A "Notion-style" block-based extensible text editor built on top of Prosemirror and Tiptap.
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00- QQwen3-Coder-Next2026年2月4日,正式发布的Qwen3-Coder-Next,一款专为编码智能体和本地开发场景设计的开源语言模型。Python00
xw-cli实现国产算力大模型零门槛部署,一键跑通 Qwen、GLM-4.7、Minimax-2.1、DeepSeek-OCR 等模型Go06
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin08
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
热门内容推荐
最新内容推荐
Degrees of Lewdity中文汉化终极指南:零基础玩家必看的完整教程Unity游戏翻译神器:XUnity Auto Translator 完整使用指南PythonWin7终极指南:在Windows 7上轻松安装Python 3.9+终极macOS键盘定制指南:用Karabiner-Elements提升10倍效率Pandas数据分析实战指南:从零基础到数据处理高手 Qwen3-235B-FP8震撼升级:256K上下文+22B激活参数7步搞定机械键盘PCB设计:从零开始打造你的专属键盘终极WeMod专业版解锁指南:3步免费获取完整高级功能DeepSeek-R1-Distill-Qwen-32B技术揭秘:小模型如何实现大模型性能突破音频修复终极指南:让每一段受损声音重获新生
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
537
3.75 K
暂无简介
Dart
773
191
Ascend Extension for PyTorch
Python
343
406
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.34 K
755
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.07 K
97
React Native鸿蒙化仓库
JavaScript
303
355
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
337
179
AscendNPU-IR
C++
86
141
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
986
248