search
githubEdit

For HTML

circle-info

Good to know: You first need to create an account on feedback.farmarrow-up-right.

hashtag
Get your Project id

You can get your project id by going to feedback.farmarrow-up-right and select your project.

hashtag
Add the widget to your site

Suppose that you have and HTML website like this

// index.html
<html>
  <head>
    ...
  </head>

  <body>
    <button>Give Feedback</button>
  </body>
</html>

You then want to add the script and the attributes to the button

// index.html
<html>
  <head>
    <script
      src="https://unpkg.com/@feedbackfarm/[email protected]/dist/widget.js"
      defer
    ></script>
  </head>

  <body>
    <button data-feedback-farm data-feedback-farm-project-id="123">
      Give Feedback
    </button>
  </body>
</html>

Now when you click the button, you should see the widget.

hashtag
Advanced option

Now that you have the widget working correctly, the widget support some properties that will allow you to customize it. Here's the available properties.

Property Name
Value Type
Description

data-feedback-farm

empty*

You need to add this attributes to make it work

data-feedback-farm-identifier

string

A string identifier that represent the user submitting the feedback. Ex: userId, email, ...

data-feedback-farm-localization

object**

You can update the widget default text

data-feedback-farm-page-name

string

The page where the feedback was submitted

data-feedback-farm-project-id

string*

Feedback Farm project identifier

data-feedback-farm-theme

object*

You can specify a theme that will override the default one

data-feedback-farm-types

object**

You can replace the default type, Feature ; Bug ; Other by your own

data-feedback-farm-end-image-url

string

A url to an image that you would like to show when the user submit a feedback.

*required\ **Need to be "stringified"

PreviousFor ReactNextFor Wordpress

Last updated