Seiten inline einbetten

Shayan TaslimAktualisiert

Einbettungen zeigen deine öffentlichen UserJot-Seiten direkt in deinem eigenen Layout statt in einem schwebenden Widget an. Du kannst deine Feedback-Boards, Roadmap, dein Änderungsprotokoll und Help Center einbetten. Die Nachrichtenansicht aus Conversations gibt es nur im Widget und sie kann nicht eingebettet werden.

Grundlegende Einrichtung

Füge deiner Seite ein Containerelement hinzu:

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

Initialisiere anschließend das SDK und binde die Einbettung ein:

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

Die Einbettung füllt ihren Container aus. Lege daher die Höhe des Containers mit CSS fest. Mit widget: false wird das schwebende Widget deaktiviert. Lass es aktiviert, wenn du beides zusammen verwenden möchtest.

Optionen und unterstützte Pfade

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'
});

Zulässige Werte für path:

Pfad

Was angezeigt wird

/ (oder /feedback)

Dein standardmäßiges Feedback-Board

/feedback/<board-slug>

Ein bestimmtes öffentliches Board

/feedback/p/<post-slug>

Ein bestimmter Feedback-Beitrag

/roadmap

Öffentliche Roadmap

/updates

Übersicht des Änderungsprotokolls

/updates/<slug>

Ein bestimmter Eintrag im Änderungsprotokoll

/help

Startseite des Help Centers (sofern live)

/help/collections/<slug>

Eine bestimmte Help-Center-Sammlung

/help/articles/<slug>

Ein bestimmter Help-Center-Artikel

Veraltete Pfade /board/<board-slug> und /board/p/<post-slug> leiten zu /feedback/<board-slug> und /feedback/p/<post-slug> weiter.

Eine Einbettung steuern

uj.createEmbed gibt einen Controller zurück, sobald das SDK-Skript geladen wurde:

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

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

Mit deiner URL synchronisieren

Übergib basePath, damit die Einbettung beim Navigieren durch Nutzer die Browser-URL synchron hält:

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

Mit basePath: '/feedback' bleibt die Feedback-Startseite unter /feedback, beim Öffnen eines Beitrags wird die URL in deinem Browser auf /feedback/feedback/p/<post-slug> aktualisiert, und wenn du diese URL direkt aufrufst, wird das eingebettete Element mit diesem Beitrag geöffnet.

Damit Deep Links funktionieren, konfiguriere deinen App-Router so, dass sowohl /feedback als auch /feedback/* die Seite anzeigen, auf der uj.createEmbed aufgerufen wird.

Die Identität wird automatisch übernommen

Mit uj.identify meldest du den Nutzer bei allen Einbettungen auf der Seite an (auch bei später erstellten Einbettungen); mit uj.logout meldest du ihn ab.

Da Nutzer bei eingebetteten Seiten über Automatische Anmeldung angemeldet werden, stelle sicher, dass Automatische Anmeldung unter Einstellungen → Anmeldung aktiviert ist (Tarif Starter oder Professional). Andernfalls werden Einbettungen abgemeldet geladen, selbst wenn du eine signierte Identität übergibst.

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

Mehrere Einbettungen

Du kannst mehrere Einbettungen auf derselben Seite einbinden, indem du jeder einen eigenen Container und Pfad zuweist:

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

Einbettung oder Widget?

  • Verwende das Widget, wenn Feedback, Hilfe, Neuigkeiten und Nachrichten überall in deiner App mit einem Klick erreichbar sein sollen.

  • Verwende eine Einbettung, wenn du eine eigene Seite in deinem Layout möchtest, zum Beispiel yourapp.com/feedback oder yourapp.com/help.

Viele Produkte verwenden beides. Alle Optionen für Einbettungen findest du in der SDK-Referenz.

Hat das Ihre Frage beantwortet?