@brainfish-ai/web-widget
v1.3.0-beta.0
Published
Brainfish Widgets Manager
Downloads
5,256
Readme
Brainfish In-App Widget
This package provides a simple way to integrate a Brainfish in-app widget in your website or web application. It supports the standard style, and slide-in popup.
Installation
npm install @branfish-ai/web-widget
Directly in your HTML
<script type="module">
import Brainfish from "https://cdn.jsdelivr.net/npm/@brainfish-ai/web-widget@latest/dist/web.js"
Brainfish.Widgets.init({ widgetKey: "your-key" });
</script>
<button class="brainfish-trigger-button" onClick="Brainfish.HelpWidget.open('brainfish-trigger-button')">Help</button>
<!-- The widget will emit events when it opens and closes. You can listen to these events by adding the following code to your website: -->
<!-- For close event: (onBrainfishHelpWidgetClosed) -->
<script>
window.addEventListener('onBrainfishHelpWidgetClosed', yourClosedHandlerFunction);
</script>
<!-- For opened event: (onBrainfishHelpWidgetOpened) -->
<script>
window.addEventListener('onBrainfishHelpWidgetOpened', yourOpenedHandlerFunction);
</script>
<!-- Make sure you remember to remove these event listeners when the widget is no longer needed. -->
<script>
window.removeEventListener('onBrainfishHelpWidgetClosed', yourClosedHandlerFunction);
window.removeEventListener('onBrainfishHelpWidgetOpened', yourOpenedHandlerFunction);
</script>