Встраивание страниц в строку

Shayan TaslimОбновлено

Встраиваемые страницы отображают публичные страницы UserJot прямо в интерфейсе вашего приложения, а не во всплывающем виджете. Вы можете встроить доски обратной связи, дорожную карту, журнал изменений и центр помощи. Раздел Messages из Conversations доступен только в виджете и не поддерживает встраивание.

Базовая настройка

Добавьте на страницу элемент-контейнер:

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>.

Управление встраиваемой страницей

uj.createEmbed возвращает объект управления после загрузки скрипта SDK:

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 завершает сеанс пользователя.

Поскольку авторизация пользователей на встроенных страницах выполняется через Automatic login, убедитесь, что функция Automatic login включена в разделе Settings → Login (тариф 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.

Эта статья ответила на ваш вопрос?