BugMuncher Documentation

Run-time Options

You can control and change a number of aspects of BugMuncher at run-time, through the bugmuncher_options global object in your embed code. Many of these options can be set using the embed code generator for your website.

The bugmuncher_options global object must have an api_key specified, all the other parameters detailed in this section are optional:


api_key string

Required

This is the only required option, and will automatically be added by the embed code generator. Each website in BugMuncher has its own unique API Key, this can be found on details page for that website.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]"
};

language string

Default: 'en'

This specifies the language in which the user interface should be displayed, the value must be a 2 character language code, and can be any of the following:
  • en – English (default)
  • es – Spanish
  • fr – French
  • de – German
  • it – Italian
  • pt – Portuguese
  • nl – Dutch
  • se – Swedish
  • ru – Russian
  • tr – Turkish

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  language: 'fr' // Set the language to 'French'
};

require_email boolean

Default: false

Set this to boolean true if you want to require an email address when sending feedback through BugMuncher. The default value is false.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  require_email: true
};

prefill_email string

Default: null

Set this to define a default email address, eg: authenticated users in your web app.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  prefill_email: '[email protected]'
};

position string

Default: 'right'

Can be either 'left' or 'right'. Set this to 'left' if you would like the feedback button to display on the left hand side of the screen.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  position: 'left'
};

style string

Default: 'label'

Can be either 'label' or 'tab'. Set this to 'tab' if you would like the feedback button to be displayed horizontally on the bottom of the screen, instead of vertically at the side of the screen.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  style: 'tab'
};

label_text string

Default: 'Feedback'

Modify this to change the label text on the feedback button. If you do not define this, the default of 'Feedback' will be used, and will be translated to the appropriate language if you set the language to anything but English.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  label_text: 'Report an Issue'
};

background_colour string

Default: '#222222'

Controls the background color of the Feedback button. This can be any valid Hexadecimal RGB Color.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  background_colour: '#0064cd' // Blue
};

text_colour string

Default: '#ffffff'

Controls the text color of the Feedback button, as well as the inner border color. This can be any valid Hexadecimal RGB Color.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  text_colour: '#0000000' // Black
};

http_auth string

Default: null

If your site is behind HTTP Basic authentication, you'll need to provide a username and password to allow BugMuncher to access your images, CSS files and custom fonts, otherwise the screenshots will not render correctly. The username and password should be separated by a colon, eg: username:password

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  http_auth: 'randal:correcthorsebatterystaple'
};

skip_to string

Default: null

By setting this to either specific or general you can make BugMuncher bypass the screen in which users are asked whether they'd like to give specific or general feedback, and instead skip straight to the option you specified.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  skip_to: 'general'
};

default_include_screenshot boolean

Default: false

When sending general feedback through BugMuncher, users have the option to include a full page screenshot with the feedback by ticking a checkbox. By default this checkbox is unchecked, as automatically including a screenshot could have privacy implications if the page contains sensitive information. You can make the checkbox ticked by default by setting this option to true, but be sure to only do this on pages where you know there will no information you wouldn't want included in a screenshot.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  default_include_screenshot: true
};

default_category integer

Default: false

Set this to a valid category ID for you website to pre-select a default feedback category. You can find the category IDs in the control panel, choosing 'Feedback Categories' from the left menu, and checking the ID column from the table of categories.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  default_category: 1234
};

hide_button boolean

Default: false

If you set this to true, BugMuncher will load normally, but the feedback button will not be shown. Instead you will be able to trigger BugMuncher to open using the JavaScript API's open method.

Example:

var bugmuncher_options = {
  api_key: "[YOUR API KEY HERE]",
  hide_button: true
};