Instalação do widget
A instalação do widget requer apenas um trecho de código. Cole-o próximo ao fim da sua página HTML, logo antes da tag de fechamento </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 Configurações → Login, em Segredos (ou copie o trecho de código já preenchido na página Compartilhar do seu painel). Depois de carregado, o botão de inicialização aparece no canto inferior direito da página.
O snippet inline configura um proxy window.uj que enfileira chamadas sem aguardar resposta (init, open, close, toggle, identify, logout, setTheme, setLocale, destroy) até que o SDK termine de carregar e, então, as reproduz.
A ordem das chamadas não importa
Você pode enfileirar init, identify e open no mesmo ciclo antes que o SDK termine 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 retorna undefined para todas as chamadas. Se precisar de valores de retorno ou promises, como await uj.identify(...), uj.createEmbed(...), uj.on(...) ou uj.getState(), aguarde o carregamento do script do SDK antes de chamá-los.
Sem scripts inline (CSP estrita)
Se o seu site bloquear scripts embutidos, use a instalação com uma única tag e data-project para que o SDK se inicialize sozinho:
<script
type="module"
async
src="https://cdn.userjot.com/sdk/v3/uj.js"
data-project="YOUR_PROJECT_ID"
></script>Você ainda pode chamar métodos de window.uj do seu próprio bundle quando o script carregar. Se o seu código também chamar uj.init(...), a chamada explícita terá precedência sobre data-project.
Diretivas da Política de Segurança de Conteúdo (CSP)
Se o seu app aplicar uma Política de Segurança de Conteúdo, 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 enviados)style-srcefont-src:https://cdn.userjot.com(as fontes são hospedadas no próprio domínio; não é necessário permitir o Google Fonts)frame-src:https://<your-workspace>.userjot.com(ou seu domínio personalizado) se você usar incorporações embutidas
React, Next.js e aplicativos 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 injete tags de script duplicadas ao mudar de rota.Chame
uj.init('YOUR_PROJECT_ID', ...)uma vez na inicialização do app e chameuj.identify(...)/uj.logout()quando o estado de autenticação mudar.Limpe todas as assinaturas de
uj.on(...)e os identificadores deembed.destroy()na função de limpeza do componente (o retorno deuseEffect).
Configuração
Passe as opções como segundo argumento para 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 pelo seu próprio botão, em vez de usar o botão de inicialização padrão. Veja Como controlar o widget para conferir exemplos.
Verificar a instalação
Depois de carregar a página:
O botão de inicialização aparece no canto configurado.
Ao clicar nele, o widget é aberto.
Você pode navegar por Início e Feedback (incluindo o Roadmap quando estiver ativado) dentro do widget, além de Atualizações quando o changelog público estiver ativado.
Se a Central de Ajuda estiver ativa ou Conversas estiver habilitado, as abas Ajuda e Mensagens aparecerão automaticamente, sem necessidade de alterações adicionais no script.
Problemas comuns
O widget não aparece
Confirme se as duas tags de script estão presentes (ou a tag única com
data-project).Verifique se
YOUR_PROJECT_IDcorresponde a Configurações → Login → Segredos.Verifique se você não passou
widget: falseoulauncher: falseeminit.Verifique se há erros de Política de Segurança de Conteúdo no console do navegador bloqueando
cdn.userjot.comouwidget.userjot.com.
As chamadas parecem não fazer nada
Se uj.open() ou uj.identify(...) não fizer nada, confirme se uj.init(...) foi executado na página. As chamadas enfileiradas antes de init aguardam até que init seja executado, e o SDK registra um aviso no console se ainda houver chamadas enfileiradas sem init.
Próxima etapa
Conecte o widget aos usuários que fizeram login em Identificar usuários.