supabugs-widget
v1.0.6
Published
Javascript widget to record issues directly on Supabugs from every site
Downloads
33
Readme
Supabugs Widget
A tiny widget to collect feedback / issues / bugs from anywhere on supabugs. That’s it.
Quick Start
Load the widget on your page:
<script src="https://unpkg.com/supabugs-widget@latest" defer></script>
Set a div to open the widget:
<div id="supabugs__widget__container" data-token="XYZ" data-type="true" data-priority="true" data-severity="true" data-attachments="true" ></div>
Setting up the Widget
This is the URL to send the feedback to. The widget will make a POST request to this URL with the feedback data as a JSON body.
Options
Options are set as data-
properties:
data-token
The token generated from your Supabugs account. The widget will create issues
with this token, so be careful to set up a long term expiring date and to give
it at least Issue Create
permissions.
data-type
Default false
. Set it to true
if you want to show the issue Type select
dropdown.
data-priority
Default false
. Set it to true
if you want to show the issue Priority select
dropdown.
data-severity
Default false
. Set it to true
if you want to show the issue Severity select
dropdown.
data-attachments
Default false
. Set it to true
if you want to show the upload Attachments
field.
data-caption
The text behind the form. Something like "Report a new issue for this website"
How it works
When the script is loaded, it looks for the element with the
supabugs__widget__container
id and inject the create issue iframe from
supabugs
Contributing
Contribute to Supabugs with issues and pull requests in the GitHub repo.