Встановлення віджета

Shayan TaslimОновлено

Щоб установити віджет, достатньо одного фрагмента коду. Вставте його ближче до кінця HTML-сторінки, безпосередньо перед закривальним тегом </body>:

HTML
<script>
  window.uj ||= new Proxy(
    {},
    {
      get: (_, p) =>
        p == 'then'
          ? 0
          : (...a) => {
              (window.$ujq ||= []).push([p, ...a]);
            }
    }
  );
  uj.init('YOUR_PROJECT_ID');
</script>
<script type="module" async src="https://cdn.userjot.com/sdk/v3/uj.js"></script>

Знайдіть YOUR_PROJECT_ID у розділі Settings → Login у підрозділі Secrets (або скопіюйте попередньо заповнений фрагмент коду зі сторінки Share у своїй панелі керування). Після завантаження віджета кнопка запуску з’явиться в нижньому правому куті сторінки.

Вбудований фрагмент коду налаштовує проксі window.uj, який ставить виклики типу fire-and-forget у чергу (init, open, close, toggle, identify, logout, setTheme, setLocale, destroy) до завершення завантаження SDK, а потім повторно їх відтворює.

Порядок викликів не має значення

Ви можете поставити в чергу init, identify і open в одному циклі, перш ніж SDK завершить завантаження:

HTML
<script>
  window.uj ||= new Proxy(
    {},
    {
      get: (_, p) =>
        p == 'then'
          ? 0
          : (...a) => {
              (window.$ujq ||= []).push([p, ...a]);
            }
    }
  );
  uj.init('YOUR_PROJECT_ID');
  uj.identify({ user: { id: 'user-123', email: 'user@example.com' } });
</script>
<script type="module" async src="https://cdn.userjot.com/sdk/v3/uj.js"></script>
Note

Проксі, який працює до завантаження, повертає undefined для кожного виклику. Якщо вам потрібні значення, що повертаються, або проміси, наприклад await uj.identify(...), uj.createEmbed(...), uj.on(...) чи uj.getState(), дочекайтеся завантаження скрипту SDK, перш ніж викликати їх.

Без вбудованих скриптів (сувора CSP)

Якщо ваш сайт блокує вбудовані скрипти, скористайтеся встановленням одним тегом із data-project, щоб SDK ініціалізувався самостійно:

HTML
<script
  type="module"
  async
  src="https://cdn.userjot.com/sdk/v3/uj.js"
  data-project="YOUR_PROJECT_ID"
></script>

Після завантаження скрипту ви й далі зможете викликати методи window.uj зі свого пакета. Якщо ваш код також викликає uj.init(...), явний виклик має пріоритет над data-project.

Директиви політики безпеки вмісту (CSP)

Якщо у вашому застосунку діє політика безпеки вмісту, дозвольте такі джерела UserJot:

  • script-src: https://cdn.userjot.com

  • connect-src: https://widget.userjot.com wss://widget.userjot.com https://collect.jotlens.com (SDK надсилає легкі сигнальні дані телеметрії віджета на collect.jotlens.com із хостів, які не є локальними)

  • img-src: https://media.userjot.com (і https://cdn.userjot.com для завантажених ресурсів)

  • style-src і font-src: https://cdn.userjot.com (шрифти розміщено на власному сервері; дозвіл для Google Fonts не потрібен)

  • frame-src: https://<your-workspace>.userjot.com (або ваш власний домен), якщо ви використовуєте вбудовані вставки

React, Next.js і односторінкові застосунки

  • Завантажте https://cdn.userjot.com/sdk/v3/uj.js один раз у кореневому макеті (наприклад, за допомогою <Script strategy="afterInteractive" /> у Next.js або в index.html). Не додавайте дублікати тегів script під час переходів між маршрутами.

  • Викличте uj.init('YOUR_PROJECT_ID', ...) один раз під час запуску застосунку, а uj.identify(...) / uj.logout() — коли змінюється стан автентифікації.

  • Скасуйте всі підписки uj.on(...) та звільніть ресурси embed.destroy() під час очищення компонента (у функції, яку повертає useEffect).

Налаштування

Передайте параметри другим аргументом у init:

JavaScript
uj.init('YOUR_PROJECT_ID', {
  widget: {
    position: 'right', // 'left' or 'right'
    theme: 'auto', // 'auto', 'light', or 'dark'
    launcher: true // false hides the default button
  },
  locale: 'en-US' // optional override
});

Усі параметри необов’язкові. Установіть launcher: false, щоб відкривати віджет власною кнопкою замість стандартної кнопки запуску. Приклади див. у розділі Керування віджетом.

Перевірте встановлення

Після завантаження сторінки:

  1. Кнопка запуску з’явиться у вказаному куті.

  2. Натисніть її, щоб відкрити віджет.

  3. У віджеті можна переглядати Головну і Відгуки (зокрема Дорожню карту, якщо її ввімкнено), а також Оновлення, якщо у вас увімкнено загальнодоступний журнал змін.

Якщо Help Center опубліковано або ввімкнено Conversations, вкладки Help і Messages з’являться автоматично, без додаткових змін у скрипті.

Поширені проблеми

Віджет не з’являється

  • Переконайтеся, що на сторінці є обидва теги script (або один тег із data-project).

  • Переконайтеся, що значення YOUR_PROJECT_ID відповідає значенню в розділі Settings → Login → Secrets.

  • Переконайтеся, що ви не передали widget: false або launcher: false у init.

  • Перевірте консоль браузера на наявність помилок політики безпеки вмісту, які блокують cdn.userjot.com або widget.userjot.com.

Виклики, схоже, нічого не роблять

Якщо виклик uj.open() або uj.identify(...) нічого не робить, переконайтеся, що на сторінці виконано uj.init(...). Виклики, поставлені в чергу до init, чекатимуть, доки не буде виконано init, а SDK виведе попередження в консоль, якщо виклики залишаться в черзі без init.

Наступний крок

Зв’яжіть віджет із користувачами, які ввійшли в систему, у розділі Ідентифікація користувачів.

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