@brainfish-ai/chat-widget
TypeScript icon, indicating that this package has built-in type declarations

0.0.60 • Public • Published

Brainfish Chat Widget

This is a simple chat widget that can be embedded on any website. It is built using SolidJS and Socket.io.

Installation

npm install @branfish-ai/chat-widget

Directly in your HTML

<script type="module">
  import ChatWidget from 'https://cdn.jsdelivr.net/npm/@branfish-ai/chat-widget'

  ChatWidget.initStandard({
    chatAppId: 'YOUR_CHAT_APP_ID',
  })
</script>

<brainfish-standard-widget style="width: 100%; height: 600px; "></brainfish-standard-widget>

Popup

You can get the popup HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Share" tab of your typebot.

Here is an example:

<script type="module">
  import ChatWidget from "https://cdn.jsdelivr.net/npm/@branfish-ai/chat-widget/dist/web.js";

  ChatWidget.initPopup({
    chatAppId: "YOUR_CHAT_APP_ID",
    autoShowDelay: 3000,
  });
</script>

This code will automatically trigger the popup window after 3 seconds.

Open or Close a popup

You can use these commands:

ChatWidget.open();
ChatWidget.close();
ChatWidget.toggle();

You can bind these commands on a button element, for example:

<button onclick="ChatWidget.open()">Contact us</button>

Bubble

You can get the bubble HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Share" tab of your typebot.

Here is an example:

<script type="module">
  import ChatWidget from "https://cdn.jsdelivr.net/npm/@branfish-ai/chat-widget/dist/web.js";

  ChatWidget.initBubble({
    chatAppId: "YOUR_CHAT_APP_ID",
    previewMessage: {
      message: "Need help?",
      autoShowDelay: 5000,
      avatarUrl: "https://cdn-icons-png.flaticon.com/512/1587/1587565.png",
    },
    theme: {
      button: { backgroundColor: "#0042DA", iconColor: "#FFFFFF" },
      chatWindow: { backgroundColor: "#ffffff" },
    },
    settings: {
      languageSelector: {
        isEnabled: true,
      },
    },
  });
</script>

This code will show the bubble and let a preview message appear after 5 seconds.

Open or close the preview message

You can use these commands:

ChatWidget.showPreviewMessage();
ChatWidget.hidePreviewMessage();

This code will show the bubble and let a preview message appear after 5 seconds.

Open or close the typebot

You can use these commands:

ChatWidget.open();
ChatWidget.close();
ChatWidget.toggle();

You can bind these commands on a button element, for example:

<button onclick="ChatWidget.open()">Contact us</button>

Readme

Keywords

none

Package Sidebar

Install

npm i @brainfish-ai/chat-widget

Weekly Downloads

0

Version

0.0.60

License

none

Unpacked Size

1.38 MB

Total Files

14

Last publish

Collaborators

  • johnfumaster
  • ajainvivek