Widget 概览
UserJot widget 会在你的网站上提供一个统一的应用内入口,让用户查看反馈、路线图、产品更新、帮助文章并发送私信。
此文档集合中介绍的 API 稳定可靠。我们会不断添加新功能,不会重命名方法或破坏现有行为。
Widget 包含哪些内容
底部导航栏会根据工作区中启用的功能自动调整:
首页:始终显示。展示近期更新、帮助链接、正在进行的路线图亮点(启用路线图后),以及当前用户的动态。
消息:启用 对话 后显示。供客户、Juno 和团队直接聊天。
帮助:帮助中心上线后显示。可在应用内搜索和阅读帮助文章。
反馈:始终显示。无需离开应用,即可浏览、搜索、投票、评论和提交反馈(路线图也位于“反馈”和“首页”下,或可通过
uj.open({ to: 'roadmap' })直接打开)。客户输入新想法(至少 3 个字符)时,如果看板上已有匹配的请求,编辑器会实时显示看板上已有的建议卡片。更新:启用公开更新日志后显示,启动器上会显示未读提示。
通知:已识别用户的标题栏中会显示铃铛,提示他们关注的请求有新动态。
在桌面视口(宽度大于 760px)中,只要小组件保持打开状态,同一标签页内的页面重新加载或跳转后,系统会在 30 分钟内记住小组件的打开状态、当前界面和滚动位置。帮助文章和更新日志会在桌面端自动展开为更宽的阅读视图,对话线程也包含展开切换按钮。
截图和标注
客户通过小组件提交反馈时,最多可附加 4 张图片(PNG、JPEG 或 WebP,每张最大 10 MB),可通过选择文件、从剪贴板粘贴,或点击相机按钮截取屏幕截图来添加。
捕获并自动回退:点击截图按钮会使用浏览器标签页/屏幕捕获功能(
getDisplayMedia);如果屏幕捕获不可用,则会自动回退到页面内 DOM 捕获(自动隐藏小组件界面)。内置标注编辑器:附加截图前,客户可以使用六种工具标注截图,每种工具都支持单键快捷键:选择(V)、画笔(P)、箭头(A)、方框(R)、文本(T)和像素化遮盖(B);此外还提供六种颜色、“撤销”功能,以及使用 Delete / Backspace 删除选中形状。
隐私遮罩:在页面内进行 DOM 捕获时,UserJot 会自动遮盖
password、email和tel输入框、其name中包含token或secret的输入框,以及标记为data-userjot-sensitive的文本区域。添加data-userjot-capture-ignore可将任意 DOM 元素排除在捕获范围之外,添加data-userjot-capture-mask可自动遮盖该元素。
权限、编辑和审核
匿名用户与已识别用户:匿名访客可以浏览、提交新反馈、发起访客对话,以及对更新日志动态做出回应。为反馈投票、发表评论,以及查看小组件中的通知铃铛,都需要使用已识别用户身份。
编辑和删除自己的内容:客户可以通过
...菜单直接编辑(帖子标题和正文;评论正文)并删除自己的帖子和评论。在小组件中,编辑或删除自己的帖子或评论需要使用已签名身份(未签名的uj.identify会话无法编辑或删除内容)。审核:通过小组件提交的反馈遵循工作区的审核设置。提交回执会确认反馈已保存;反馈在显示于公开看板之前仍可能需要审核。请参阅审核内容。
所有套餐均允许通过小组件匿名提交,无论公开看板的访客提交设置如何。该设置仅适用于公开看板。由于小组件可通过编程控制,您可以决定何时加载或显示它(例如,仅向已登录用户显示)。提交反馈无需进行身份识别。
你可以用它构建什么
只需复制并粘贴一段代码,widget 即可开箱即用;SDK 还提供了程序化控制功能:
使用 open(),从自己的界面打开 widget 的任意部分。
用自定义按钮替换默认入口,并显示实时未读徽标。
响应 widget 事件,例如打开、关闭、在线状态和未读数量。
以内嵌方式嵌入完整页面,而不是使用浮动入口。