如何使用prosMirror创建变量功能并配置schema实现模板占位符转换
富文本编辑器变量插入功能的Schema配置与导出适配
核心需求
- 编辑态渲染:用户插入的变量展示为带蓝色背景、
editor-variable类名、携带data-value属性的行内<span>元素,支持正常的选中、移动、删除交互 - 导出态转换:所有匹配上述特征的变量节点,导出为HTML时自动替换为
{{变量名}}格式的模板占位符,普通文本、其他区块内容保持原样输出
具体实现步骤
1. Schema规则配置
首先需要在编辑器的Schema校验规则中,将自定义变量节点声明为合法的行内原子元素,避免编辑器的内容净化逻辑自动移除自定义类名、属性,导致节点结构损坏:
// 以主流ProseMirror架构的富文本编辑器为例,定义变量节点的Schema规则 const VariableNode = { inline: true, group: 'inline', atom: true, // 标记为原子节点,不允许内部拆分编辑,保持变量块的完整性 attrs: { varName: '' // 存储对应的变量名 }, // 解析DOM时的匹配规则 parseDOM: [{ tag: 'span.editor-variable', getAttrs: (dom) => ({ varName: dom.getAttribute('data-value') }) }], // 编辑态的DOM渲染逻辑,和导出逻辑做分离 toDOM: (node) => [ 'span', { class: 'editor-variable', style: 'background: blue;', 'data-value': node.attrs.varName }, node.attrs.varName ] }
注意:必须将变量节点标记为atom: true的原子节点,否则用户编辑过程中可能会拆分、修改变量块内部的文本,导致data-value和展示文本不匹配的结构问题。
2. 导出逻辑适配
因为Schema中的toDOM方法是专门服务于编辑态渲染的,不能直接把{{变量名}}的渲染逻辑写在里面,否则编辑阶段就看不到可视化的蓝色变量块。需要单独实现HTML导出的转换逻辑:
- 先通过编辑器的内置序列化方法拿到包含变量块的原始DOM字符串
- 用正则批量匹配所有符合
editor-variable类特征的span节点,读取节点上的data-value属性值 - 将整个匹配到的span标签替换为
{{变量名}}的纯文本占位符
对应的转换实现:
function getExportHTML(rawEditorHTML) { // 正则匹配所有变量span,兼容属性顺序不一致的情况 const variableSpanReg = /<span\s+[^>]*class="[^"]*editor-variable[^"]*"[^>]*>.*?<\/span>/g return rawEditorHTML.replace(variableSpanReg, (spanMatch) => { // 从匹配到的span字符串中提取data-value的变量名 const valueMatch = spanMatch.match(/data-value="([^"]+)"/) if (!valueMatch) return spanMatch // 匹配不到变量名的节点保持原样 return `{{${valueMatch[1]}}}` }) }
效果对照:
编辑器编辑态原始内容:<div>hello <span style="background:blue;" class="editor-variable" data-value="fullName">fullName</span></div><div>this is another row</div>
经过导出函数处理后输出的结果:<div>hello {{fullName}}</div><div>this is another row</div>
内容的提问来源于stack exchange,提问作者user8987378
相关产品推荐
相关产品推荐

