Instalação do widget
A instalação do widget requer apenas um excerto de código. Cole-o perto do fim da página HTML, imediatamente antes da etiqueta de fecho </body>:
<script>
window.uj ||= new Proxy(
{},
{
get: (_, p) =>
p == 'then'
? 0
: (...a) => {
(window.$ujq ||= []).push([p, ...a]);
}
}
);
uj.init('YOUR_PROJECT_ID');
</script>
<script type="module" async src="https://cdn.userjot.com/sdk/v3/uj.js"></script>Encontre YOUR_PROJECT_ID em Settings → Login, em Secrets (ou copie o excerto de código pré-preenchido da página Share no seu painel). Depois de carregado, o botão de abertura aparece no canto inferior direito da página.
O snippet inline configura um window.uj proxy que coloca em fila chamadas fire-and-forget (init, open, close, toggle, identify, logout, setTheme, setLocale, destroy) até o SDK terminar de carregar e as reproduz.
A ordem das chamadas não é importante
Pode colocar init, identify e open em fila no mesmo ciclo antes de o SDK terminar de carregar:
<script>
window.uj ||= new Proxy(
{},
{
get: (_, p) =>
p == 'then'
? 0
: (...a) => {
(window.$ujq ||= []).push([p, ...a]);
}
}
);
uj.init('YOUR_PROJECT_ID');
uj.identify({ user: { id: 'user-123', email: 'user@example.com' } });
</script>
<script type="module" async src="https://cdn.userjot.com/sdk/v3/uj.js"></script>O proxy anterior ao carregamento devolve undefined em todas as chamadas. Se precisar de valores de retorno ou promessas, como await uj.identify(...), uj.createEmbed(...), uj.on(...) ou uj.getState(), aguarde até o script do SDK carregar para as chamar.
Sem scripts inline (CSP rigorosa)
Se o seu site bloquear scripts incorporados, use a instalação com uma única etiqueta e data-project para que o SDK se inicialize automaticamente:
<script
type="module"
async
src="https://cdn.userjot.com/sdk/v3/uj.js"
data-project="YOUR_PROJECT_ID"
></script>Depois de o script carregar, pode chamar métodos window.uj a partir do seu próprio bundle. Se o seu código também chamar uj.init(...), a chamada explícita tem prioridade sobre data-project.
Diretivas da Content Security Policy (CSP)
Se a sua aplicação aplicar uma Content Security Policy, permita estas origens do UserJot:
script-src:https://cdn.userjot.comconnect-src:https://widget.userjot.com wss://widget.userjot.com https://collect.jotlens.com(o SDK envia sinais leves de telemetria do widget paracollect.jotlens.comem hosts não locais)img-src:https://media.userjot.com(ehttps://cdn.userjot.compara recursos carregados)style-srcefont-src:https://cdn.userjot.com(os tipos de letra são alojados no próprio domínio; não é necessário permitir o Google Fonts)frame-src:https://<your-workspace>.userjot.com(ou o seu domínio personalizado) se utilizar incorporações em linha
React, Next.js e aplicações de página única
Carregue
https://cdn.userjot.com/sdk/v3/uj.jsuma vez no layout raiz (por exemplo, com<Script strategy="afterInteractive" />no Next.js ou emindex.html). Não insira etiquetas de script duplicadas ao mudar de rota.Chame
uj.init('YOUR_PROJECT_ID', ...)uma vez ao iniciar a aplicação e chameuj.identify(...)/uj.logout()quando o estado de autenticação mudar.Limpe quaisquer subscrições de
uj.on(...)e identificadores deembed.destroy()na função de limpeza do componente (o retorno deuseEffect).
Configuração
Passe as opções como segundo argumento de init:
uj.init('YOUR_PROJECT_ID', {
widget: {
position: 'right', // 'left' or 'right'
theme: 'auto', // 'auto', 'light', or 'dark'
launcher: true // false hides the default button
},
locale: 'en-US' // optional override
});Todas as opções são opcionais. Defina launcher: false para abrir o widget a partir do seu próprio botão, em vez de utilizar o botão de abertura predefinido. Consulte Controlling the widget para ver exemplos.
Verificar a instalação
Depois de carregar a página:
O botão de abertura aparece no canto configurado.
Ao clicar nele, o widget abre-se.
Pode navegar por Início e Feedback (incluindo Roadmap, quando ativado) dentro do widget, além de Atualizações quando o registo público de alterações estiver ativado.
Se o Help Center estiver ativo ou as Conversations estiverem ativadas, os separadores Help e Messages aparecem automaticamente, sem necessidade de alterar o script.
Problemas comuns
O widget não aparece
Confirme que ambas as etiquetas de script estão presentes (ou que está presente a etiqueta única com
data-project).Verifique se
YOUR_PROJECT_IDcorresponde a Settings → Login → Secrets.Verifique se não passou
widget: falseoulauncher: falseeminit.Verifique na consola do browser se existem erros da Content Security Policy que estejam a bloquear
cdn.userjot.comouwidget.userjot.com.
As chamadas parecem não fazer nada
Se uj.open() ou uj.identify(...) não fizer nada, confirme que uj.init(...) foi executado na página. As chamadas colocadas em fila antes de init aguardam até init ser executado, e o SDK apresenta um aviso na consola se houver chamadas ainda em fila sem init.
Próximo passo
Associe o widget aos utilizadores com sessão iniciada em Identificar utilizadores.