Instalacja widżetu

Shayan TaslimZaktualizowano

Instalacja widżetu wymaga wklejenia jednego fragmentu kodu. Wklej go pod koniec strony HTML, tuż przed zamykającym znacznikiem </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>

Znajdź YOUR_PROJECT_ID w sekcji Ustawienia → Logowanie, w obszarze Klucze tajne (lub skopiuj wstępnie wypełniony fragment kodu ze strony Udostępnianie w panelu). Po załadowaniu widżetu przycisk uruchamiający pojawi się w prawym dolnym rogu strony.

Fragment inline konfiguruje window.uj proxy, które kolejkuje wywołania typu fire-and-forget (init, open, close, toggle, identify, logout, setTheme, setLocale, destroy) do czasu zakończenia ładowania SDK, a następnie je odtwarza.

Kolejność wywołań nie ma znaczenia

Możesz zakolejkować init, identify i open w tym samym cyklu, zanim pakiet SDK zakończy ładowanie:

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

Proxy działające przed załadowaniem zwraca undefined przy każdym wywołaniu. Jeśli potrzebujesz wartości zwracanych lub obietnic, takich jak await uj.identify(...), uj.createEmbed(...), uj.on(...) lub uj.getState(), przed ich wywołaniem poczekaj na załadowanie skryptu SDK.

Bez skryptów wbudowanych (restrykcyjna polityka CSP)

Jeśli Twoja witryna blokuje skrypty wbudowane, użyj instalacji z jednym znacznikiem i data-project, aby pakiet SDK zainicjował się samodzielnie:

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

Po załadowaniu skryptu nadal możesz wywoływać metody window.uj z własnego pakietu. Jeśli Twój kod wywołuje również uj.init(...), jawne wywołanie ma pierwszeństwo przed data-project.

Dyrektywy Content Security Policy (CSP)

Jeśli Twoja aplikacja wymusza Content Security Policy, dodaj do dozwolonych te źródła UserJot:

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

  • connect-src: https://widget.userjot.com wss://widget.userjot.com https://collect.jotlens.com (SDK wysyła lekkie sygnały telemetryczne widżetu do collect.jotlens.com na hostach innych niż lokalne)

  • img-src: https://media.userjot.com (oraz https://cdn.userjot.com w przypadku przesyłanych zasobów)

  • style-src i font-src: https://cdn.userjot.com (czcionki są hostowane we własnej infrastrukturze, więc nie trzeba zezwalać na Google Fonts)

  • frame-src: https://<your-workspace>.userjot.com (lub Twoja domena niestandardowa), jeśli korzystasz z osadzonych elementów

React, Next.js i aplikacje jednostronicowe

  • Załaduj https://cdn.userjot.com/sdk/v3/uj.js raz w głównym układzie (na przykład za pomocą <Script strategy="afterInteractive" /> w Next.js lub w index.html). Nie dodawaj zduplikowanych znaczników skryptu podczas zmiany tras.

  • Wywołaj uj.init('YOUR_PROJECT_ID', ...) raz podczas uruchamiania aplikacji, a uj.identify(...) / uj.logout() — za każdym razem, gdy zmieni się stan uwierzytelnienia.

  • W funkcji czyszczącej komponentu (wartość zwracana przez useEffect) usuń wszystkie subskrypcje uj.on(...) i uchwyty embed.destroy().

Konfiguracja

Przekaż opcje jako drugi argument do 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
});

Wszystkie opcje są opcjonalne. Ustaw launcher: false, aby otwierać widżet własnym przyciskiem zamiast domyślnego przycisku uruchamiającego. Przykłady znajdziesz w artykule Sterowanie widżetem.

Sprawdź instalację

Po załadowaniu strony:

  1. Przycisk uruchamiający pojawi się w skonfigurowanym rogu.

  2. Kliknięcie go otworzy widżet.

  3. W widżecie możesz przeglądać Stronę główną i Opinie (w tym Plan rozwoju, jeśli jest włączony), a także Aktualności, jeśli publiczny dziennik zmian jest włączony.

Jeśli Centrum pomocy jest aktywne lub Rozmowy są włączone, karty Pomoc i Wiadomości pojawią się automatycznie — bez dodatkowych zmian w skrypcie.

Typowe problemy

Widżet się nie pojawia

  • Upewnij się, że oba znaczniki skryptu są obecne (lub że jest jeden znacznik z data-project).

  • Sprawdź, czy YOUR_PROJECT_ID jest zgodne z wartością w sekcji Ustawienia → Logowanie → Klucze tajne.

  • Sprawdź, czy w init nie przekazujesz widget: false ani launcher: false.

  • Sprawdź w konsoli przeglądarki, czy błędy Content Security Policy nie blokują cdn.userjot.com lub widget.userjot.com.

Wywołania pozornie nic nie robią

Jeśli uj.open() lub uj.identify(...) nic nie robi, upewnij się, że na stronie uruchomiono uj.init(...). Wywołania zakolejkowane przed init zaczekają na uruchomienie init, a pakiet SDK wyświetli ostrzeżenie w konsoli, jeśli wywołania pozostaną w kolejce bez init.

Następny krok

Połącz widżet z zalogowanymi użytkownikami — zobacz Identyfikowanie użytkowników.

Czy ten artykuł odpowiedział na Twoje pytanie?