Установка виджета

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 в разделе Настройки → Вход → Секреты (или скопируйте готовый фрагмент кода со страницы Поделиться в панели управления). После загрузки кнопка виджета появится в правом нижнем углу страницы.

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

Порядок вызовов не имеет значения

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

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

Прокси, работающий до загрузки SDK, возвращает 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.

Директивы Content Security Policy (CSP)

Если в вашем приложении действует Content Security Policy, разрешите следующие источники 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() при очистке компонента (в блоке return 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. В виджете можно просматривать разделы Главная и Обратная связь (а также раздел «Дорожная карта», если он включён), а ещё Обновления, если у вас включён публичный журнал изменений.

Если Справочный центр опубликован или включен раздел Обращения, вкладки Помощь и Сообщения появятся автоматически — менять скрипт не нужно.

Распространённые проблемы

Виджет не отображается

  • Убедитесь, что на странице присутствуют оба тега script (или один тег с data-project).

  • Проверьте, что значение YOUR_PROJECT_ID совпадает со значением в разделе Настройки → Вход → Секреты.

  • Убедитесь, что вы не передали widget: false или launcher: false в init.

  • Проверьте консоль браузера на наличие ошибок Content Security Policy, блокирующих cdn.userjot.com или widget.userjot.com.

Вызовы ничего не делают

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

Следующий шаг

Свяжите виджет с вошедшими в систему пользователями в разделе Идентификация пользователей.

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