sitegpt-tools

0.2.7 • Public • Published

SiteGPT Tools

Provides a basic interface in Javascript to control the SiteGPT.ai UI interface elements.

You can open, close, show, hide, or toggle the UI using this tiny script.

You can include the following on your website to import the script:

<script src="https://cdn.jsdelivr.net/gh/kidgodzilla/sitegpt-tools@latest/m.js"></script>

API

Hide or Show the SiteGPT.ai button

window._sitegpt.hide(); // Hides the SiteGPT button
window._sitegpt.show(); // Shows the SiteGPT button

Open or Close the SiteGPT.ai button

window._sitegpt.open(); // Opens the SiteGPT chat interface
window._sitegpt.close(); // Closes the SiteGPT chat interface
window._sitegpt.toggle(); // Toggles the SiteGPT chat interface

Helper functions

window._sitegpt.is_open() // Returns true if the chat window is currently open, otherwise false

window._sitegpt.exists() // Determines if the chat interface is ready

window._sitegpt.on_ready(function () {
    // Executes when the chat interface is available. Can be used to hide the interface on load.
});

Recipes

Add SiteGPT.ai to Crisp.chat

<script src="https://cdn.jsdelivr.net/gh/kidgodzilla/sitegpt-tools@latest/m.js"></script>
<script>
  if (window.$crisp && window.$crisp.push) {
    $crisp.push(["on", "session:loaded", window._sitegpt.add_to_crisp]);
    $crisp.push(["on", "chat:opened", window._sitegpt.add_to_crisp]);
    $crisp.push(["on", "chat:opened", window._sitegpt.close]);
  } else {
    window.CRISP_READY_TRIGGER = function() {
      $crisp.push(["on", "session:loaded", window._sitegpt.add_to_crisp]);
      $crisp.push(["on", "chat:opened", window._sitegpt.add_to_crisp]);
      $crisp.push(["on", "chat:opened", window._sitegpt.close]);
    }
  }

  window._sitegpt.on_ready(window._sitegpt.hide);
</script>

Package Sidebar

Install

npm i sitegpt-tools

Weekly Downloads

0

Version

0.2.7

License

ISC

Unpacked Size

5.54 kB

Total Files

4

Last publish

Collaborators

  • kidgodzilla