Visão geral

Para utilizar efetivamente a API JavaScript da UserGuiding e garantir que suas funções personalizadas sejam executadas corretamente, é crucial saber quando o script da UserGuiding foi totalmente carregado. Há dois métodos principais para lidar com isso, que envolvem a configuração dos ouvintes de eventos (event listeners) ou variáveis globais que acionam suas funções assim que a UserGuiding estiver pronta.

Métodos para garantir a prontidão do script e da API

1. Usando o método userGuidingLayer.push: Esse método permite que você defina uma função que será executada assim que o script da UserGuiding for carregado. Ao enviar um evento onload para o userGuidingLayer, você pode acionar seu código personalizado de acordo. 
   
2. • Implementação: Adicione o código a seguir no seu script para configurar o evento onload:
     
     

     javascript
     Copy codewindow.userGuidingLayer.push({
       event: 'onload',
       fn: _YOUR_FUNCTION_HERE_,
     });
     

   • • Explanation: Substitua _YOUR_FUNCTION_HERE_ pela função real que deseja executar quando a UserGuiding estiver totalmente carregada. Essa configuração garante que sua função seja executada no momento certo.
       
3. Definição da variável onUserGuidingLoad: Como alternativa, você pode usar uma variável global chamada onUserGuidingLoad. Atribua sua função a essa variável para garantir que ela seja executada assim que o script da UserGuiding for carregado. 
   
4. • Implementação: Inclua o código a seguir no seu script:
     
     

     javascript
     Copy codewindow.onUserGuidingLoad = _YOUR_FUNCTION_HERE_;
     

   • • Explicação: Novamente, substitua _YOUR_FUNCTION_HERE_ pela função que você deseja executar. Esse método fornece uma maneira direta de configurar um retorno de chamada para quando a UserGuiding estiver pronta.

Escolhendo o método correto

• Flexibilidade: O método userGuidingLayer.push oferece flexibilidade e pode ser usado para vários eventos. A variável onUserGuidingLoad é uma abordagem mais simples, ideal para funções únicas.
• Caso de uso: selecione o método com base em seus requisitos e na complexidade da sua implementação. Ambas as abordagens garantem que as interações da API do JavaScript ocorram quando a UserGuiding estiver totalmente operacional.

Usando esses métodos, é possível gerenciar com confiança quando as funções são executadas em relação ao carregamento do script da UserGuiding, garantindo integração e funcionalidade sem problemas.