Incorporar páginas diretamente
Os embeds exibem suas páginas públicas do UserJot dentro do layout do seu próprio app, em vez de um widget flutuante. Você pode incorporar seus quadros de feedback, roadmap, changelog e central de ajuda. A superfície Messages do Conversations está disponível apenas no widget e não pode ser incorporada.
Configuração básica
Adicione um elemento contêiner à sua página:
<div data-userjot-embed style="height: 700px"></div>Em seguida, inicialize o SDK e monte o embed:
uj.init('YOUR_PROJECT_ID', { widget: false });
uj.createEmbed();O embed ocupa todo o contêiner, então defina a altura dele com CSS. Passar widget: false desativa o widget flutuante; se preferir, deixe-o ativado para usar os dois juntos.
Opções e caminhos compatíveis
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'
});Valores válidos para path:
Caminho | O que é exibido |
|---|---|
| Seu quadro de feedback padrão |
| Um quadro público específico |
| Uma publicação específica de feedback |
| Roadmap público |
| Índice do changelog |
| Uma atualização específica do changelog |
| Página inicial da Central de Ajuda (quando publicada) |
| Uma coleção específica da Central de Ajuda |
| Um artigo específico da Central de Ajuda |
Os caminhos antigos /board/<board-slug> e /board/p/<post-slug> redirecionam para /feedback/<board-slug> e /feedback/p/<post-slug>.
Como controlar um embed
uj.createEmbed retorna um controlador quando o script do SDK é carregado:
const embed = uj.createEmbed({ path: '/' });
embed.navigate('/roadmap'); // switch to another page
embed.destroy(); // unmount the embedSincronização com sua URL
Passe basePath para que o embed mantenha a URL do navegador sincronizada enquanto os usuários navegam:
uj.createEmbed({
container: '#feedback-page',
basePath: '/feedback'
});Com basePath: '/feedback', a página de feedback raiz permanece em /feedback, abrir uma publicação atualiza a URL do navegador para /feedback/feedback/p/<post-slug>, e carregar essa URL diretamente abre a incorporação nessa publicação.
Para que os links diretos funcionem, configure o roteador do seu app para que tanto /feedback quanto /feedback/* renderizem a página que chama uj.createEmbed.
A identidade é aplicada automaticamente
Chamar uj.identify conecta o usuário a todos os embeds da página (inclusive os criados posteriormente), e uj.logout desconecta o usuário.
Como o login dos usuários em páginas incorporadas é feito por meio do Login automático, verifique se o Login automático está ativado em Configurações → Login (plano Starter ou Professional). Sem isso, os embeds serão carregados com a sessão desconectada, mesmo que você passe uma identidade autenticada.
uj.identify({ token: 'TOKEN_FROM_YOUR_SERVER' });
uj.createEmbed();Vários embeds
Monte vários embeds na mesma página, atribuindo a cada um seu próprio contêiner e caminho:
uj.createEmbed({ container: '#board', path: '/' });
uj.createEmbed({ container: '#roadmap', path: '/roadmap' });Embed ou widget?
Use o widget quando quiser que feedback, ajuda, atualizações e mensagens estejam a um clique de distância em qualquer lugar do seu app.
Use um embed quando quiser uma página dedicada dentro do layout do seu próprio app, como
yourapp.com/feedbackouyourapp.com/help.
Muitos produtos usam os dois. Consulte a referência do SDK para ver todas as opções de embed.