Вбудовування сторінок безпосередньо в інтерфейс
Вбудовані сторінки відображають публічні сторінки UserJot у вашому макеті замість плаваючого віджета. Ви можете вбудувати дошки відгуків, дорожню карту, журнал змін і центр довідки. Розділ Messages у Conversations доступний лише у віджеті й не підтримує вбудовування.
Основне налаштування
Додайте на сторінку контейнерний елемент:
<div data-userjot-embed style="height: 700px"></div>Потім ініціалізуйте SDK і змонтуйте вбудовану сторінку:
uj.init('YOUR_PROJECT_ID', { widget: false });
uj.createEmbed();Вбудована сторінка заповнює контейнер, тому задайте висоту контейнера за допомогою CSS. Передайте widget: false, щоб вимкнути плаваючий віджет, або залиште його ввімкненим, щоб використовувати обидва варіанти.
Параметри та підтримувані шляхи
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:
Шлях | Що відображається |
|---|---|
| Ваша дошка відгуків за замовчуванням |
| Певна публічна дошка |
| Певний допис із відгуком |
| Публічна дорожня карта |
| Головна сторінка журналу змін |
| Певне оновлення в журналі змін |
| Головна сторінка Центру довідки (коли він опублікований) |
| Певна колекція Центру довідки |
| Певна стаття Центру довідки |
Застарілі шляхи /board/<board-slug> і /board/p/<post-slug> перенаправляють на /feedback/<board-slug> і /feedback/p/<post-slug>.
Керування вбудованим елементом
uj.createEmbed повертає контролер після завантаження скрипту SDK:
const embed = uj.createEmbed({ path: '/' });
embed.navigate('/roadmap'); // switch to another page
embed.destroy(); // unmount the embedСинхронізація з URL-адресою
Передайте basePath, щоб URL-адреса браузера синхронізувалася з вбудованою сторінкою під час навігації користувачів:
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). Якщо цю функцію не ввімкнено, користувачі відкриватимуть вбудовані сторінки неавторизованими, навіть якщо ви передасте підписану ідентичність.
uj.identify({ token: 'TOKEN_FROM_YOUR_SERVER' });
uj.createEmbed();Кілька вбудованих елементів
Щоб розмістити на одній сторінці кілька вбудованих сторінок, задайте для кожної окремий контейнер і шлях:
uj.createEmbed({ container: '#board', path: '/' });
uj.createEmbed({ container: '#roadmap', path: '/roadmap' });Вбудований елемент чи віджет?
Використовуйте віджет, якщо відгуки, довідка, оновлення та повідомлення мають бути доступні в один клік з будь-якого місця у вашому застосунку.
Використовуйте вбудовану сторінку, якщо вам потрібна окрема сторінка у власному макеті, наприклад
yourapp.com/feedbackабоyourapp.com/help.
У багатьох продуктах використовують обидва варіанти. Повний перелік параметрів вбудовування див. у довідці з SDK.