Incorporare pagine in linea

Shayan TaslimAggiornato

Gli embed visualizzano le tue pagine pubbliche di UserJot direttamente nel layout della tua app, anziché in un widget flottante. Puoi incorporare le bacheche dei feedback, la roadmap, il changelog e il centro assistenza. La sezione Messaggi di Conversations è disponibile solo nel widget e non può essere incorporata.

Configurazione di base

Aggiungi un elemento contenitore alla tua pagina:

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

Quindi inizializza l’SDK e monta l’embed:

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

L’embed occupa tutto il contenitore, quindi imposta l’altezza del contenitore con i CSS. Passando widget: false disattivi il widget flottante; in alternativa, lascialo attivo per usare entrambi.

Opzioni e percorsi supportati

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

Valori validi per path:

Percorso

Contenuto visualizzato

/ (o /feedback)

La tua bacheca dei feedback predefinita

/feedback/<board-slug>

Una specifica bacheca pubblica

/feedback/p/<post-slug>

Un post specifico sui feedback

/roadmap

Roadmap pubblica

/updates

Indice del changelog

/updates/<slug>

Un aggiornamento specifico del changelog

/help

Pagina iniziale del Centro assistenza (quando è online)

/help/collections/<slug>

Una specifica raccolta del Centro assistenza

/help/articles/<slug>

Un articolo specifico del Centro assistenza

I percorsi legacy /board/<board-slug> e /board/p/<post-slug> reindirizzano a /feedback/<board-slug> e /feedback/p/<post-slug>.

Gestire un incorporamento

uj.createEmbed restituisce un controller una volta caricato lo script dell’SDK:

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

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

Sincronizzare con il tuo URL

Passa basePath affinché l’embed mantenga sincronizzato l’URL del browser durante la navigazione degli utenti:

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

Con basePath: '/feedback', la pagina principale dei feedback rimane su /feedback, l'apertura di un post aggiorna l'URL del browser a /feedback/feedback/p/<post-slug> e il caricamento diretto di quell'URL apre l'embed su quel post.

Per abilitare i deep link, configura il router della tua app in modo che sia /feedback sia /feedback/* visualizzino la pagina che chiama uj.createEmbed.

L'identità viene trasferita automaticamente

La chiamata a uj.identify fa accedere l’utente a tutti gli embed presenti nella pagina (compresi quelli creati in seguito), mentre uj.logout lo disconnette.

Poiché l’accesso degli utenti alle pagine incorporate avviene tramite Automatic login, assicurati che Automatic login sia attivo in Settings → Login (piano Starter o Professional). Se non è attivo, gli embed verranno caricati senza che l’utente abbia effettuato l’accesso, anche quando passi un’identità autenticata.

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

Più incorporamenti

Per montare più embed nella stessa pagina, assegna a ciascuno un contenitore e un percorso distinti:

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

Incorporamento o widget?

  • Usa il widget quando vuoi che feedback, assistenza, aggiornamenti e messaggi siano accessibili con un clic da qualsiasi punto della tua app.

  • Usa un embed quando vuoi una pagina dedicata all’interno del tuo layout, ad esempio yourapp.com/feedback o yourapp.com/help.

Molti prodotti usano entrambe le soluzioni. Consulta la documentazione di riferimento dell’SDK per tutte le opzioni degli embed.

Ha risposto alla tua domanda?