Company Logo
Conselhos e respostas da equipe UserGuiding
Usuários
Engajamento
Configurações
Casos de Uso e Boas Práticas
Acionando um Guia via JavaScript
Você pode chamar um Guia programaticamente usando JavaScript.

Você pode acionar facilmente um Guia usando o seguinte método da nossa API JavaScript.


userGuiding.previewGuide(guideId)

 

Você pode encontrar o guideId nas configurações do seu Guia, abaixo do título do Guia.



No exemplo abaixo, estamos acionando um Guia por meio de um botão HTML.


<button onclick="window.userGuiding.previewGuide(guideId)">Play my Guide!</button>


Se você quiser que o Guia seja acionado somente se as condições de direcionamento forem atendidas, defina checkHistory como false. Se for verdadeiro, ele tentará atender às condições de direcionamento e segmentação. O valor padrão é false.


userGuiding.previewGuide(guideId, { 
  checkHistory: true,
})


Por fim, você também pode iniciar um Guia a partir de uma etapa específica. O valor padrão é 0 (primeira etapa).


userGuiding.previewGuide(guideId, { 
  initialStep: 2,
})