Skip to content

Gurubase/gurubase-widget

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gurubase Widget

This repository includes the script for the 'Ask AI' widget, which you can add to your Guru's AI capabilities into your website.

widget demo

Prerequisites

  • Your website should have a Guru on Gurubase.io. If not, request a new Guru.
  • You need to have a Widget ID. You can get it from your Guru's settings page on Gurubase.io.
    • Go to "My Gurus" page
    • Select the Guru you want to add the widget to
    • On the "Widget" section create a new widget
    • Copy the Widget ID and use it in the installation section

Installation

The only thing you need to do is to add the widget.js to your website as follows:

<!-- Gurubase Widget -->
<script async src="https://widget.gurubase.io/widget.latest.min.js" 
    data-widget-id="<your_widget_id>"
    id="guru-widget-id">
</script>

Important

The value of the id attribute should be "guru-widget-id", don't change it.

src, data-widget-id, id are required. You can modify the rest of the attributes to customize the widget by using the below options.

Configuration Options

Option Type Description Default
data-widget-id string Your widget ID Required
data-text string Text displayed on the chat button "Ask AI"
data-margins object Button positioning margins { bottom: "20px", right: "20px" }
data-bg-color string Primary color for the widget Fetched from the Gurubase.io
data-icon-url string URL to your company/product logo Fetched from the Gurubase.io
data-name string Your company/product name Fetched from the Gurubase.io
data-light-mode boolean Whether to use light mode false