Pular para o conteúdo principal

Introdução ao PluginJS

O PluginJS é o script embarcável da PliQ: um único arquivo pliqcx.js que você adiciona ao HTML do seu site ou sistema para exibir pesquisas de satisfação sem construir nada — o plugin cuida da exibição, do direcionamento e da comunicação com a plataforma.

Novo na v7

O bundle agora é pliqcx.js. A API continua como window.PliQ/_pliqStt. Chegou também o widget do tipo action button, disparado por um botão do seu site. Ver Novidades e Widgets de ação.

Todo o visual do plugin (modais, botões flutuantes, painel de debug) é renderizado dentro de um Shadow DOM e o CSS vai embutido no próprio .js:

  • ✅ Um arquivo só — não existe mais .css separado
  • ✅ Isolamento total de estilos — o CSS do seu site não afeta o plugin, e vice-versa
  • ✅ Visual renovado — cantos arredondados, sombras suaves e animações leves

Como funciona​

  1. Você cola o snippet de instalação com o token da sua empresa
  2. No login do seu app, chama window.PliQ.initialize(contato) com os dados da pessoa
  3. O plugin busca na API as pesquisas vinculadas àquele contato e passa a monitorar a navegação
  4. Ao entrar numa tela que casa com a configuração, o modal da pesquisa abre sozinho; widgets aparecem conforme o alvo
  5. No logout do seu app, chama window.PliQ.closeSession()
O plugin não configura pesquisas

Widgets e disparos são configurados dentro da plataforma PliQ — o plugin só executa o que foi configurado lá.

Os dois sistemas de exibição​

O plugin exibe pesquisas por dois sistemas independentes, que convivem no mesmo script:

Disparos (Comunicação)Widgets
Como apareceModal abre automaticamente ao navegarBotão flutuante que a pessoa clica
DirecionamentoURL (regex), agendamento e limite de exibiçõesDispositivo (desktop/tablet/mobile) + regras de URL
AparênciaControlada pelo snippet (position, blockBackground…)Configurada por widget na plataforma
Onde se configuraPesquisa → Comunicação → aba PopupIntegrações → Plugin → Widgets

Uma mesma pesquisa pode ter disparo e widget, ou só um dos dois.

Widgets de ação (v7)

Além do botão flutuante, um widget pode ser do tipo action: sem botão do plugin, disparado por um elemento do seu site (data-pliq-widget ou PliQ.openWidget()). Ótimo para abrir a pesquisa numa ação real — ver Widgets de ação.

Compatível com SPA​

O plugin detecta mudanças de rota automaticamente (polling de URL a cada 1 segundo). Funciona com React, Vue, Angular e qualquer SPA — não é preciso chamar nada extra ao navegar entre páginas.

Pré-requisitos​

Para que a pesquisa seja exibida corretamente, você precisa de:

  1. Snippet instalado na página — ver Instalação
  2. Token de Plugin ativo — gerado na plataforma PliQ
  3. initialize chamado no login do seu app com os dados do contato — ver Métodos
  4. Pesquisa configurada na plataforma (popup de comunicação agendado para o contato, ou widget ativo)

Vídeo de instrução​

Para mais detalhes, assista ao vídeo: Instalação e uso do PluginJS

Testando a integração

A v6 traz um painel de debug visual que mostra a sessão ativa, os disparos e widgets recebidos e o motivo de cada um aparecer (ou não) na tela atual. Ver Modo Debug.