Incorporar páginas em linha

Shayan TaslimAtualizado

As incorporações apresentam as suas páginas públicas do UserJot no layout da sua própria aplicação, em vez de num widget flutuante. Pode incorporar os seus quadros de feedback, roteiro, registo de alterações e centro de ajuda. A secção Messages de Conversations só está disponível no widget e não pode ser incorporada.

Configuração básica

Adicione um elemento de contentor à sua página:

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

Em seguida, inicialize o SDK e monte a incorporação:

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

A incorporação ocupa todo o contentor, por isso defina a altura do contentor com CSS. Passar widget: false desativa o widget flutuante; em alternativa, mantenha-o ativado para utilizar ambos em conjunto.

Opções e caminhos suportados

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

Valores válidos de path:

Caminho

O que apresenta

/ (ou /feedback)

O seu quadro de feedback predefinido

/feedback/<board-slug>

Um quadro público específico

/feedback/p/<post-slug>

Uma publicação de feedback específica

/roadmap

Roteiro público

/updates

Índice do registo de alterações

/updates/<slug>

Uma atualização específica do registo de alterações

/help

Página inicial do Centro de ajuda (quando estiver publicado)

/help/collections/<slug>

Uma coleção específica do Centro de ajuda

/help/articles/<slug>

Um artigo específico do Centro de ajuda

Os caminhos antigos /board/<board-slug> e /board/p/<post-slug> redirecionam para /feedback/<board-slug> e /feedback/p/<post-slug>.

Controlar uma incorporação

uj.createEmbed devolve um controlador assim que o script do SDK for carregado:

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

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

Sincronizar com o seu URL

Passe basePath para que a incorporação mantenha o URL do navegador sincronizado à medida que os utilizadores navegam:

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

Com basePath: '/feedback', a página principal de comentários mantém-se em /feedback, abrir uma publicação atualiza o URL do browser para /feedback/feedback/p/<post-slug> e carregar esse URL diretamente abre a incorporação nessa publicação.

Para que as ligações diretas funcionem, configure o router da sua aplicação para que tanto /feedback como /feedback/* apresentem a página que chama uj.createEmbed.

A identidade é aplicada automaticamente

Ao chamar uj.identify, inicia sessão do utilizador em todas as incorporações da página (incluindo as criadas posteriormente); uj.logout termina a sessão.

Como o início de sessão dos utilizadores em páginas incorporadas é feito através do início de sessão automático, certifique-se de que o início de sessão automático está ativado em Definições → Iniciar sessão (plano Starter ou Professional). Sem esta opção, as incorporações são carregadas com a sessão terminada, mesmo que passe uma identidade autenticada.

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

Várias incorporações

Monte várias incorporações na mesma página, atribuindo a cada uma o seu próprio contentor e caminho:

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

Incorporação ou widget?

  • Utilize o widget quando quiser que o feedback, a ajuda, as atualizações e as mensagens estejam sempre acessíveis na sua aplicação com apenas um clique.

  • Utilize uma incorporação quando quiser uma página dedicada no layout da sua própria aplicação, como yourapp.com/feedback ou yourapp.com/help.

Muitos produtos utilizam ambos. Consulte a referência do SDK para ver todas as opções de incorporação.

Isto respondeu à sua pergunta?