内嵌页面

Shayan Taslim更新

嵌入内容会在你自己的布局中显示公开的 UserJot 页面,而不是使用浮动小组件。你可以嵌入反馈看板、路线图、更新日志和帮助中心。Conversations 中的 Messages 界面仅在小组件中提供,无法嵌入。

基本设置

在页面中添加一个容器元素:

HTML
<div data-userjot-embed style="height: 700px"></div>

然后初始化 SDK 并挂载嵌入内容:

JavaScript
uj.init('YOUR_PROJECT_ID', { widget: false });
uj.createEmbed();

嵌入内容会填满其容器,因此请使用 CSS 设置容器高度。传入 widget: false 会关闭浮动小组件;也可以让它保持启用,以便同时使用两者。

选项和支持的路径

JavaScript
uj.createEmbed({
  container: '#my-container', // CSS selector or DOM element, default '[data-userjot-embed]'
  path: '/roadmap',           // initial page, default '/'
  theme: 'auto'               // 'auto', 'light', or 'dark'
});

有效的 path 值:

路径

显示内容

/(或 /feedback)

你的默认反馈看板

/feedback/<board-slug>

指定的公开看板

/feedback/p/<post-slug>

指定的反馈帖子

/roadmap

公开路线图

/updates

更新日志索引

/updates/<slug>

指定的更新日志条目

/help

帮助中心首页(上线后)

/help/collections/<slug>

指定的帮助中心分类

/help/articles/<slug>

指定的帮助中心文章

旧版 /board/<board-slug> 和 /board/p/<post-slug> 路径会重定向到 /feedback/<board-slug> 和 /feedback/p/<post-slug>。

控制嵌入内容

SDK 脚本加载后,uj.createEmbed 会返回一个控制器:

JavaScript
const embed = uj.createEmbed({ path: '/' });

embed.navigate('/roadmap'); // switch to another page
embed.destroy();            // unmount the embed

与 URL 同步

传入 basePath,让嵌入内容在用户浏览时与浏览器 URL 保持同步:

JavaScript
uj.createEmbed({
  container: '#feedback-page',
  basePath: '/feedback'
});

使用 basePath: '/feedback' 后,根反馈页面仍位于 /feedback;打开帖子时,浏览器 URL 会更新为 /feedback/feedback/p/<post-slug>,直接加载该 URL 则会打开嵌入页面并显示该帖子。

要让深层链接正常工作,请配置应用路由器,使 /feedback 和 /feedback/* 都能渲染调用 uj.createEmbed 的页面。

身份会自动传递

调用 uj.identify 会让用户登录页面上的所有嵌入内容(包括之后创建的嵌入内容);调用 uj.logout 则会让用户退出登录。

由于嵌入页面中的用户登录通过自动登录实现,请确保在设置 → 登录中启用自动登录(需使用 Starter 或 Professional 套餐)。如果未启用,即使传入了已签名的身份信息,嵌入内容也会以未登录状态加载。

JavaScript
uj.identify({ token: 'TOKEN_FROM_YOUR_SERVER' });
uj.createEmbed();

多个嵌入内容

为每个嵌入内容指定独立的容器和路径,即可在同一页面上挂载多个嵌入内容:

JavaScript
uj.createEmbed({ container: '#board', path: '/' });
uj.createEmbed({ container: '#roadmap', path: '/roadmap' });

选择嵌入内容还是小组件?

  • 如果希望用户在应用的任何位置都能一键访问反馈、帮助、更新和消息,请使用小组件。

  • 如果你想在自己的布局中创建专属页面,例如 yourapp.com/feedback 或 yourapp.com/help,请使用嵌入内容。

许多产品会同时使用两者。所有嵌入选项请参阅 SDK 参考。

这是否解答了您的问题?