Вбудовування сторінок безпосередньо в інтерфейс

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 виконує вихід.

Оскільки вхід користувачів на вбудовані сторінки відбувається через Автоматичний вхід, переконайтеся, що в Налаштування → Вхід увімкнено Автоматичний вхід (план 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.

Чи відповіла ця стаття на ваше запитання?