Pagina's inline insluiten

Shayan TaslimBijgewerkt:

Ingesloten pagina's tonen je openbare UserJot-pagina's in je eigen lay-out, in plaats van in een zwevende widget. Je kunt je feedbackborden, roadmap, changelog en helpcentrum insluiten. De weergave Berichten uit Conversaties is alleen beschikbaar in de widget en kan niet worden ingesloten.

Basisinstellingen

Voeg een containerelement toe aan je pagina:

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

Initialiseer vervolgens de SDK en plaats de embed:

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

De embed vult de container, dus stel de hoogte van de container in met CSS. Door widget: false mee te geven, wordt de zwevende widget uitgeschakeld. Laat deze optie weg om beide tegelijk te gebruiken.

Opties en ondersteunde paden

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

Geldige waarden voor path:

Pad

Wat er wordt weergegeven

/ (of /feedback)

Je standaardfeedbackbord

/feedback/<board-slug>

Een specifiek openbaar bord

/feedback/p/<post-slug>

Een specifieke feedbackpost

/roadmap

Openbare roadmap

/updates

Changelogoverzicht

/updates/<slug>

Een specifieke changelogupdate

/help

Startpagina van het helpcentrum (wanneer deze is gepubliceerd)

/help/collections/<slug>

Een specifieke collectie in het helpcentrum

/help/articles/<slug>

Een specifiek artikel in het helpcentrum

Verouderde paden /board/<board-slug> en /board/p/<post-slug> verwijzen door naar /feedback/<board-slug> en /feedback/p/<post-slug>.

Een insluiting bedienen

uj.createEmbed geeft een controller terug zodra het SDK-script is geladen:

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

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

Synchroniseren met je URL

Geef basePath mee zodat de embed de URL van je browser synchroniseert terwijl gebruikers navigeren:

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

Met basePath: '/feedback' blijft de feedbackpagina op het hoogste niveau op /feedback, wordt de URL in je browser bijgewerkt naar /feedback/feedback/p/<post-slug> wanneer je een bericht opent, en wordt de embed met dat bericht geopend als je die URL rechtstreeks laadt.

Configureer je approuter zodat zowel /feedback als /feedback/* de pagina weergeven die uj.createEmbed aanroept. Zo werken deeplinks.

Identiteit wordt automatisch doorgegeven

Met uj.identify meld je de gebruiker aan bij elke embed op de pagina, ook bij embeds die later worden gemaakt. Met uj.logout meld je de gebruiker af.

Omdat gebruikers bij ingesloten pagina's worden aangemeld via Automatisch aanmelden, moet Automatisch aanmelden zijn ingeschakeld onder Instellingen → Aanmelden (Starter- of Professional-abonnement). Zonder deze optie worden embeds geopend zonder dat de gebruiker is aangemeld, ook als je een aangemelde identiteit meegeeft.

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

Meerdere insluitingen

Plaats meerdere embeds op dezelfde pagina door elke embed een eigen container en pad te geven:

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

Insluiting of widget?

  • Gebruik de widget als feedback, hulp, updates en berichten overal in je app met één klik beschikbaar moeten zijn.

  • Gebruik een embed als je een speciale pagina in je eigen lay-out wilt, zoals yourapp.com/feedback of yourapp.com/help.

Veel producten gebruiken beide. Bekijk de SDK-referentie voor alle embedopties.

Heeft dit je vraag beantwoord?