Widget installeren

Shayan TaslimBijgewerkt:

Je installeert de widget met één codefragment. Plak dit aan het einde van je HTML-pagina, vlak voor de afsluitende </body>-tag:

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>

Je vindt YOUR_PROJECT_ID in Instellingen → Inloggen onder Geheimen (of kopieer het vooraf ingevulde codefragment van de pagina Delen in je dashboard). Zodra de widget is geladen, verschijnt de launcher rechtsonder op je pagina.

Het inline fragment zet een window.uj-proxy op die fire-and-forget-aanroepen (init, open, close, toggle, identify, logout, setTheme, setLocale, destroy) in de wachtrij plaatst totdat de SDK klaar is met laden en ze vervolgens opnieuw afspeelt.

De volgorde van aanroepen maakt niet uit

Je kunt init, identify en open in dezelfde tick in de wachtrij zetten voordat de SDK klaar is met laden:

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

De proxy vóór het laden retourneert bij elke aanroep undefined. Als je retourwaarden of promises nodig hebt, zoals bij await uj.identify(...), uj.createEmbed(...), uj.on(...) of uj.getState(), wacht dan met aanroepen totdat het SDK-script is geladen.

Geen inline scripts (strikte CSP)

Als je site inline scripts blokkeert, gebruik dan de installatie met één tag en data-project zodat de SDK zichzelf initialiseert:

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

Je kunt nog steeds window.uj-methoden aanroepen vanuit je eigen bundle zodra het script is geladen. Als je code ook uj.init(...) aanroept, krijgt je expliciete aanroep voorrang op data-project.

Richtlijnen voor Content Security Policy (CSP)

Als je app een Content Security Policy afdwingt, sta dan deze UserJot-oorsprongen toe:

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

  • connect-src: https://widget.userjot.com wss://widget.userjot.com https://collect.jotlens.com (de SDK verstuurt lichte telemetriebeacons voor widgets naar collect.jotlens.com op niet-lokale hosts)

  • img-src: https://media.userjot.com (en https://cdn.userjot.com voor geüploade assets)

  • style-src en font-src: https://cdn.userjot.com (de lettertypen worden zelf gehost; toestemming voor Google Fonts is niet nodig)

  • frame-src: https://<your-workspace>.userjot.com (of je aangepaste domein) als je inline insluitingen gebruikt

React, Next.js en singlepage-apps

  • Laad https://cdn.userjot.com/sdk/v3/uj.js één keer in je rootlayout (bijvoorbeeld met <Script strategy="afterInteractive" /> in Next.js of in index.html). Voeg geen dubbele scripttags toe wanneer je van route wisselt.

  • Roep uj.init('YOUR_PROJECT_ID', ...) één keer aan bij het opstarten van de app en roep uj.identify(...) / uj.logout() aan wanneer de aanmeldstatus verandert.

  • Ruim eventuele uj.on(...)-abonnementen en embed.destroy()-handles op in de cleanup van je component (de return van useEffect).

Configuratie

Geef opties als tweede argument door aan 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
});

Alle opties zijn optioneel. Stel launcher: false in om de widget te openen via je eigen knop in plaats van de standaardlauncher. Bekijk De widget bedienen voor voorbeelden.

Controleer de installatie

Nadat je pagina is geladen:

  1. De launcherknop verschijnt in de ingestelde hoek.

  2. Als je erop klikt, wordt de widget geopend.

  3. Je kunt in de widget door Startpagina en Feedback bladeren (inclusief Roadmap wanneer ingeschakeld), en ook door Updates wanneer je openbare changelog is ingeschakeld.

Als het Helpcentrum live is of Gesprekken is ingeschakeld, verschijnen de tabbladen Help en Berichten automatisch. Je hoeft hiervoor geen scripts aan te passen.

Veelvoorkomende problemen

De widget verschijnt niet

  • Controleer of beide scripttags aanwezig zijn (of de enkele tag met data-project).

  • Controleer of YOUR_PROJECT_ID overeenkomt met Instellingen → Inloggen → Geheimen.

  • Controleer of je widget: false of launcher: false niet hebt doorgegeven in init.

  • Controleer in de browserconsole of Content Security Policy-fouten cdn.userjot.com of widget.userjot.com blokkeren.

Aanroepen lijken niets te doen

Als uj.open() of uj.identify(...) niets doet, controleer dan of uj.init(...) op de pagina is uitgevoerd. Aanroepen die vóór init in de wachtrij zijn gezet, wachten totdat init wordt uitgevoerd. De SDK geeft een waarschuwing in de console als er aanroepen in de wachtrij blijven staan zonder init.

Volgende stap

Koppel de widget aan je aangemelde gebruikers via Gebruikers identificeren.

Heeft dit je vraag beantwoord?