Installation du widget

Shayan TaslimMis à jour

L’installation du widget ne nécessite qu’un seul extrait de code. Collez-le vers la fin de votre page HTML, juste avant la balise fermante </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>

Trouvez YOUR_PROJECT_ID dans Paramètres → Connexion, sous Secrets (ou copiez l’extrait prérempli depuis la page Partager de votre tableau de bord). Une fois le widget chargé, le bouton de lancement apparaît dans le coin inférieur droit de votre page.

L’extrait intégré configure un proxy window.uj qui met en file d’attente les appels fire-and-forget (init, open, close, toggle, identify, logout, setTheme, setLocale, destroy) jusqu’à ce que le SDK ait fini de se charger, puis les rejoue.

L’ordre des appels n’a pas d’importance

Vous pouvez mettre init, identify et open en file d’attente au cours du même tick, avant la fin du chargement du 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

Le proxy utilisé avant le chargement renvoie undefined pour chaque appel. Si vous avez besoin de valeurs de retour ou de promesses, par exemple avec await uj.identify(...), uj.createEmbed(...), uj.on(...) ou uj.getState(), attendez que le script du SDK soit chargé avant de les appeler.

Pas de scripts intégrés (CSP stricte)

Si votre site bloque les scripts intégrés, utilisez l’installation avec une seule balise et data-project pour que le SDK s’initialise lui-même :

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

Vous pouvez toujours appeler les méthodes window.uj depuis votre propre bundle une fois le script chargé. Si votre code appelle également uj.init(...), votre appel explicite est prioritaire sur data-project.

Directives de la Content Security Policy (CSP)

Si votre application applique une Content Security Policy, autorisez les origines UserJot suivantes :

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

  • connect-src : https://widget.userjot.com wss://widget.userjot.com https://collect.jotlens.com (le SDK envoie de légères balises de télémétrie du widget à collect.jotlens.com sur les hôtes non locaux)

  • img-src : https://media.userjot.com (et https://cdn.userjot.com pour les ressources téléversées)

  • style-src et font-src : https://cdn.userjot.com (les polices sont hébergées sur nos serveurs ; aucune autorisation pour Google Fonts n’est nécessaire)

  • frame-src : https://<your-workspace>.userjot.com (ou votre domaine personnalisé) si vous utilisez des intégrations intégrées

React, Next.js et les applications monopages

  • Chargez https://cdn.userjot.com/sdk/v3/uj.js une seule fois dans la mise en page racine (par exemple, avec <Script strategy="afterInteractive" /> dans Next.js ou dans index.html). N’insérez pas de balises de script en double lors des changements de route.

  • Appelez uj.init('YOUR_PROJECT_ID', ...) une seule fois au démarrage de l’application, puis appelez uj.identify(...) / uj.logout() lorsque l’état d’authentification change.

  • Nettoyez les abonnements uj.on(...) et les références embed.destroy() dans la fonction de nettoyage de votre composant (le retour de useEffect).

Configuration

Transmettez les options en deuxième argument à 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
});

Toutes les options sont facultatives. Définissez launcher: false pour ouvrir le widget depuis votre propre bouton plutôt que depuis le bouton de lancement par défaut. Consultez Contrôler le widget pour voir des exemples.

Vérifier l’installation

Après le chargement de votre page :

  1. Le bouton de lancement apparaît dans le coin configuré.

  2. Un clic dessus ouvre le widget.

  3. Vous pouvez parcourir Accueil et Commentaires (y compris la feuille de route lorsqu’elle est activée) dans le widget, ainsi que Actualités lorsque le journal des modifications public est activé.

Si le Centre d’aide est en ligne ou si les Conversations sont activées, les onglets Aide et Messages apparaissent automatiquement, sans aucune modification supplémentaire du script.

Problèmes courants

Le widget ne s’affiche pas

  • Vérifiez que les deux balises de script sont présentes (ou qu’il y a une seule balise avec data-project).

  • Vérifiez que YOUR_PROJECT_ID correspond à Paramètres → Connexion → Secrets.

  • Vérifiez que vous n’avez pas transmis widget: false ou launcher: false dans init.

  • Vérifiez dans la console du navigateur si des erreurs de Content Security Policy bloquent cdn.userjot.com ou widget.userjot.com.

Les appels semblent ne rien faire

Si uj.open() ou uj.identify(...) ne fait rien, vérifiez que uj.init(...) s’est exécuté sur la page. Les appels mis en file d’attente avant init attendent que init s’exécute. Le SDK affiche un avertissement dans la console si des appels restent en attente sans init.

Étape suivante

Associez le widget aux utilisateurs connectés dans Identifier les utilisateurs.

Cet article a-t-il répondu à votre question ?