Plate 如何给选中文本添加批注式 Comment 评论?
Plate 如何给选中文本添加批注式 Comment 评论【免费下载链接】plateRich-text editor with AI and shadcn/ui项目地址: https://gitcode.com/GitHub_Trending/pl/plate在 Plate 编辑器里批注式评论Comment是把一段选中文本包上文本标记text mark 内联注释实现文字上的悬停批注、多人对同一段文字叠加多条评论、以及先建草稿再定稿的协作流程。这个能力由platejs/comment提供核心是BaseCommentPlugin暴露的tf.comment.setDraft对当前选区打上一个评论标记再通过工具栏按钮或Cmd Shift M快捷键触发。本文基于 Comment 插件文档/(collaboration)/comment.mdx)给出从安装到给选中文本加批注的完整操作路径。前提一个已创建好的 Plate 编辑器两条接入路径都要求你已经用platejs/react的createPlateEditor创建过编辑器并能向它的plugins数组里追加插件import { createPlateEditor } from platejs/react; const editor createPlateEditor({ plugins: [ // ...otherPlugins, ], });路径一用 CommentKit 快速接入最快方式是引入预配置好的CommentKit它包含commentPlugin、CommentLeaf渲染评论文本标记和BlockDiscussion渲染带评论的讨论 UI以及配套 Plate UI 组件。Kit 的源码可以在仓库里直接查看comment-kit.tsx。import { createPlateEditor } from platejs/react; import { CommentKit } from /components/editor/plugins/comment-kit; const editor createPlateEditor({ plugins: [ // ...otherPlugins, ...CommentKit, ], });Kit 路径下不需要自己写插件配置加进plugins后即可使用。路径二手动配置 commentPlugin需要自定义状态、快捷键或渲染组件时走手动路径。1. 安装插件包npm install platejs/comment2. 扩展 BaseCommentPlugin声明评论状态BaseCommentPlugin之外扩展三个 options用来跟踪当前激活的评论和正在评论的块import { type ExtendConfig, type Path, isSlateString } from platejs; import { type BaseCommentConfig, BaseCommentPlugin, getDraftCommentKey, } from platejs/comment; import { toTPlatePlugin } from platejs/react; import { CommentLeaf } from /components/ui/comment-node; type CommentConfig ExtendConfig BaseCommentConfig, { activeId: string | null; commentingBlock: Path | null; hoverId: string | null; } ; export const commentPlugin toTPlatePluginCommentConfig( BaseCommentPlugin, ({ editor }) ({ options: { activeId: null, commentingBlock: null, hoverId: null, }, render: { node: CommentLeaf, }, }) );options.activeId当前激活评论的 ID用于视觉高亮options.commentingBlock正在被评论的块的 Pathoptions.hoverId当前悬停评论的 ID用于 hover 效果render.node指定CommentLeaf渲染评论文本标记组件实现见 comment-node.tsx3.可选添加点击处理跟踪激活评论点击文档中的评论标记时更新activeId点击评论外区域时清空。这一步服务于评论 UI 的激活/悬停视觉反馈export const commentPlugin toTPlatePluginCommentConfig( BaseCommentPlugin, ({ editor }) ({ handlers: { // Set active comment when clicking on comment marks onClick: ({ api, event, setOption, type }) { let leaf event.target as HTMLElement; let isSet false; const unsetActiveComment () { setOption(activeId, null); isSet true; }; if (!isSlateString(leaf)) unsetActiveComment(); while (leaf.parentElement) { if (leaf.classList.contains(slate-${type})) { const commentsEntry api.comment.node(); if (!commentsEntry) { unsetActiveComment(); break; } const id api.comment.nodeId(commentsEntry[0]); setOption(activeId, id ?? null); isSet true; break; } leaf leaf.parentElement; } if (!isSet) unsetActiveComment(); }, }, // ... previous options and render }) );处理逻辑沿 DOM 向上查找带slate-${type}class 的元素找到后用api.comment.node()取出评论节点、api.comment.nodeId()取出评论 ID 并写入activeId未命中则清空activeId。4. 扩展 setDraft绑定快捷键关键一步是扩展tf.comment.setDraft加评论前先选中所在块再打上草稿标记最后记录草稿 key 和评论块路径并绑定modshiftm快捷键export const commentPlugin toTPlatePluginCommentConfig( BaseCommentPlugin, ({ editor }) ({ // ... previous configuration }) ) .extendTransforms( ({ editor, setOption, tf: { comment: { setDraft }, }, }) ({ setDraft: () { if (editor.api.isCollapsed()) { editor.tf.select(editor.api.block()![1]); } setDraft(); editor.tf.collapse(); setOption(activeId, getDraftCommentKey()); setOption(commentingBlock, editor.selection!.focus.path.slice(0, 1)); }, }) ) .configure({ node: { component: CommentLeaf }, shortcuts: { setDraft: { keys: modshiftm }, }, });getDraftCommentKey返回草稿评论专用的 key草稿评论在最终定稿之前用这个 key 标识。5. 加入工具栏按钮并注册插件把 CommentToolbarButton 加到你的 Toolbar 中作为给选中文本加评论的显式入口。然后把插件注册进编辑器import { createPlateEditor } from platejs/react; const editor createPlateEditor({ plugins: [ // ...otherPlugins, commentPlugin, ], });如何给选中文本添加批注接好插件后给选中文本加批注有两种等价入口在编辑器里选中一段文字点击工具栏上的 Comment 按钮选中文字后按Cmd Shift M快捷键由上面的shortcuts.setDraft配置。两种入口都触发setDraft在选区上创建评论文本标记由CommentLeaf渲染为可交互的批注。同一个文本节点可以携带多条评论TCommentText除comment布尔属性外还有按评论 ID 区分的comment_id属性多条批注可叠加在同一段文字上即文档所述 Overlapping Comments。如何核对批注已生效文档给出了可编程的核查方式api.comment.has({ id })返回boolean判断指定 ID 的评论是否存在api.comment.node({ id })/api.comment.nodes()按 ID 或isDraft取回评论节点条目getCommentCount(node)统计评论节点中非草稿评论的数量。例如定稿后可以用api.comment.has({ id: 评论 ID })确认该 ID 的批注已落在文档里用api.comment.node({ isDraft: true })查看草稿是否已清除。管理评论标记用这些 transformtf.comment.removeMark从当前选区或指定位置移除评论标记tf.comment.unsetMark({ id })移除指定 ID 的评论标记传{ id, transient: true }时一次性移除所有 AI 评论默认false工具类getCommentKey(id)/getCommentKeyId(key)/getCommentKeys(node)/isCommentKey(key)用于评论 key 与 ID 的相互换算。可选与 Discussion 插件组合文档说明 comment 插件与 discussion 插件/(collaboration)/discussion.mdx) 组合可获得完整协作能力BlockDiscussion组件block-discussion.tsx负责渲染讨论 UI。需要时把discussionPlugin与commentPlugin一起加入pluginsimport { discussionPlugin } from /components/editor/plugins/discussion-kit; const editor createPlateEditor({ plugins: [ // ...otherPlugins, discussionPlugin, commentPlugin, ], });限制说明批注以文本标记形式落在文本节点上CommentLeaf未配置时评论标记没有对应渲染组件草稿评论使用getDraftCommentKey()返回的固定 key 标识与正式评论 ID 区分开tf.comment.unsetMark的transient选项按文档说明针对 AI 评论的一次性移除普通评论请显式传id。完整的插件配置项、API 参数表以 comment.mdx/(collaboration)/comment.mdx) 为准。【免费下载链接】plateRich-text editor with AI and shadcn/ui项目地址: https://gitcode.com/GitHub_Trending/pl/plate创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

相关新闻

微信小程序在线音乐播放器:从InnerAudioContext到后台播放的实践

微信小程序在线音乐播放器:从InnerAudioContext到后台播放的实践

简介:一款面向微信小程序初学者的在线音乐示例工程,适配1028版本,压缩包内置完整源代码与运行截图,可直接导入开发者工具体验音乐列表播放与页面交互效果。资源一共41个文件,压缩包约72KB,主要类型包含10张…

2026/11/18 10:43:16 阅读更多 →
financial-services提示词调优指南:把Agent范围调整到你团队的实际做法

financial-services提示词调优指南:把Agent范围调整到你团队的实际做法

financial-services提示词调优指南:把Agent范围调整到你团队的实际做法 【免费下载链接】financial-services 项目地址: https://gitcode.com/GitHub_Trending/fi/financial-services financial-services 是 Anthropic 开源的金融行业 AI Agent 模板库&…

2026/11/18 10:43:24 阅读更多 →
STM32驱动ADS1118:SPI时序与寄存器配置实战解析

STM32驱动ADS1118:SPI时序与寄存器配置实战解析

简介:压缩包内含基于STM32F103的ADS1118高精度ADC驱动例程,面向需要快速移植TI官网代码的嵌入式开发者。工程采用标准库分层结构,集成SPI/I2C通信、延时、按键、软定时器、多按键处理等模块,并保留官方驱动源文件,便于…

2026/11/18 10:43:26 阅读更多 →

最新新闻

Electron桌面应用开发实战:从环境搭建到打包发布全流程

Electron桌面应用开发实战:从环境搭建到打包发布全流程

做前端这些年,我大部分时间都在跟浏览器标签页打交道,直到第一次把桌面应用跑起来,才发现原来自己一直被限制在地址栏和刷新按钮围起来的框框里。Electron这个词,最开始是在某段时间频繁出现在同事的讨论里,一个用HTML…

2026/11/21 23:27:35 阅读更多 →
滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

简介:亚太天能T109滑盖智能锁产品说明书是一份PDF格式的官方技术文档,主要面向智能锁安装人员、终端用户及售后维护者,帮助快速掌握产品安装、配置与常见故障处理。全包仅1个PDF文件,大小4.37MB,内容结构清晰&#xff…

2026/11/21 23:27:35 阅读更多 →
PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

上个月我在调试一台高速AGV的驱动系统,整车要求空载跑到8m/s,电机转速已经拉到额定点,驱动器的输出电压也顶到了母线电压极限附近。再往上踩速度指令,转速纹丝不动,三相电流反而开始震荡。那会儿我的第一反应就是&…

2026/11/21 23:27:35 阅读更多 →
C++核心知识点:从内存管理到STL的实战指南

C++核心知识点:从内存管理到STL的实战指南

C 这门语言我前前后后折腾了十几年,用它写过嵌入式驱动、做过游戏服务端,也搭过基础组件库。每次看到新人一头扎进"C 核心知识点"这个搜索词,我其实挺感慨的——这门语言的难点从来不是语法多,而是知识点之间的耦合太深…

2026/11/21 23:27:35 阅读更多 →
T109滑盖智能锁怎么装?安装调试与故障排查全攻略

T109滑盖智能锁怎么装?安装调试与故障排查全攻略

简介:亚太天能T109滑盖智能锁产品说明书以PDF格式发布,适合智能锁用户、安装人员与售后维修人员阅读。内容围绕T109系列指纹密码刷卡锁展开,先介绍前面板、后面板、锁体、机械钥匙、电池盒盖等部件名称与功能,再给出完整安装步骤&…

2026/11/21 23:27:36 阅读更多 →
LLM知识降熵:从信息垄断到理解权下放

LLM知识降熵:从信息垄断到理解权下放

你有没有过这种经历:翻开源码注释、论文摘要或者一份专业报告,每个字都认识,连在一起却像天书。想找人聊聊,身边要么没人懂,要么懂的懒得跟你解释。后来我试着把同一段内容丢给一个大语言模型,几秒钟之后&a…

2026/11/21 23:27:37 阅读更多 →

日新闻

周新闻

月新闻