Intégrer des pages dans votre mise en page

Shayan TaslimMis à jour

Les intégrations affichent vos pages publiques UserJot dans votre propre mise en page, plutôt que dans un widget flottant. Vous pouvez intégrer vos tableaux de retours, votre feuille de route, votre journal des modifications et votre centre d’aide. La section Messages de Conversations est disponible uniquement dans le widget et ne peut pas être intégrée.

Configuration de base

Ajoutez un élément conteneur à votre page :

HTML
<div data-userjot-embed style="height: 700px"></div>

Initialisez ensuite le SDK et montez l’intégration :

JavaScript
uj.init('YOUR_PROJECT_ID', { widget: false });
uj.createEmbed();

L’intégration occupe tout l’espace de son conteneur : définissez donc la hauteur du conteneur avec CSS. En transmettant widget: false, vous désactivez le widget flottant, ou laissez-le activé pour utiliser les deux en même temps.

Options et chemins pris en charge

JavaScript
uj.createEmbed({
  container: '#my-container', // CSS selector or DOM element, default '[data-userjot-embed]'
  path: '/roadmap',           // initial page, default '/'
  theme: 'auto'               // 'auto', 'light', or 'dark'
});

Valeurs path valides :

Chemin

Contenu affiché

/ (ou /feedback)

Votre tableau de retours par défaut

/feedback/<board-slug>

Un tableau public spécifique

/feedback/p/<post-slug>

Une publication de retours spécifique

/roadmap

Feuille de route publique

/updates

Index du journal des modifications

/updates/<slug>

Une mise à jour spécifique du journal des modifications

/help

Page d’accueil du centre d’aide (lorsqu’il est publié)

/help/collections/<slug>

Une collection spécifique du centre d’aide

/help/articles/<slug>

Un article spécifique du centre d’aide

Les chemins obsolètes /board/<board-slug> et /board/p/<post-slug> redirigent vers /feedback/<board-slug> et /feedback/p/<post-slug>.

Contrôler une intégration

uj.createEmbed renvoie un contrôleur une fois le script du SDK chargé :

JavaScript
const embed = uj.createEmbed({ path: '/' });

embed.navigate('/roadmap'); // switch to another page
embed.destroy();            // unmount the embed

Synchronisation avec votre URL

Transmettez basePath pour que l’intégration synchronise l’URL de votre navigateur lorsque les utilisateurs naviguent :

JavaScript
uj.createEmbed({
  container: '#feedback-page',
  basePath: '/feedback'
});

Avec basePath: '/feedback', la page de commentaires principale reste à /feedback, l’ouverture d’une publication met à jour l’URL de votre navigateur vers /feedback/feedback/p/<post-slug>, et le chargement direct de cette URL ouvre l’intégration sur cette publication.

Pour que les liens profonds fonctionnent, configurez le routeur de votre application afin que /feedback et /feedback/* affichent tous deux la page qui appelle uj.createEmbed.

L’identité est automatiquement transmise

L’appel de uj.identify connecte l’utilisateur à toutes les intégrations de la page (y compris celles créées ultérieurement), et uj.logout le déconnecte.

Comme la connexion des utilisateurs aux pages intégrées passe par la connexion automatique, assurez-vous que la connexion automatique est activée dans Paramètres → Connexion (offre Starter ou Professional). Sinon, les intégrations se chargeront avec une session déconnectée, même si vous transmettez une identité authentifiée.

JavaScript
uj.identify({ token: 'TOKEN_FROM_YOUR_SERVER' });
uj.createEmbed();

Plusieurs intégrations

Montez plusieurs intégrations sur la même page en attribuant à chacune son propre conteneur et son propre chemin :

JavaScript
uj.createEmbed({ container: '#board', path: '/' });
uj.createEmbed({ container: '#roadmap', path: '/roadmap' });

Intégration ou widget ?

  • Utilisez le widget si vous souhaitez que les retours, l’aide, les mises à jour et les messages soient accessibles en un clic, où que vous soyez dans votre application.

  • Utilisez une intégration si vous souhaitez une page dédiée dans votre propre mise en page, comme yourapp.com/feedback ou yourapp.com/help.

De nombreux produits utilisent les deux. Consultez la référence du SDK pour découvrir toutes les options d’intégration.

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