用途:为 React 和 Next.js 应用集成 Velt 协作评论功能提供实现规范,共 87 条规则、13 个分类,按影响优先级排列,用于指导代码生成与集成模式。
主要能力:覆盖核心初始化(VeltProvider 与 API 密钥、用户认证、文档上下文);多种评论模式(Freestyle、Popover、Stream、Text、Page、Inline),并含 TipTap、SlateJS、Lexical 编辑器集成,视频播放器、Lottie 动画、Highcharts/ChartJS/Nivo 图表,以及通过 @veltdev/apryse-velt-comments 集成 Apryse WebViewer 的 PDF/docx 标注;独立组件(评论钉、评论线程、评论编辑器);侧边栏及 V2 原语架构;UI 定制与线框变量绑定;数据模型、过滤分组;调试测试;权限与审核(私有模式、可见性);附件与表情回应;配置项(@提及、状态优先级、反应、附件、富文本格式、导航、DOM 控制、侧边栏管理与访问模式、审核工作流、组件属性);线框变量(评论气泡、对话框、工具、内联评论区、多线程、自动补全、文本评论、侧边栏按钮与侧边栏)。另含 AI 智能体评论 API 参考:创建智能体标注用 POST /v2/commentannotations/add,读取用 POST /v2/commentannotations/get,客户端通过 useCommentEventCallback 订阅 suggestionAccepted/suggestionRejected 事件。
使用方式:从 AGENTS.md 压缩索引开始,再按需阅读 rules/shared/... 下各规则文件,内含说明、正误代码示例与官方文档指引。
适用场景:需要为上述框架、编辑器、媒体与图表添加协作评论或 AI 智能体建议接受/拒绝交互的应用。
限制:本资料仅为规则索引与摘要,未提供完整代码示例或具体安装步骤;具体依赖版本、定价与平台支持暂未提供。