Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Widget to capture User Feedback on your site. Manage it inside Planbox.

branch: master

Deprecated callback. Created more specific onshow callback. Passing D…

…OM element of entire dialog instead of jQuery element of content as was the case with callback.
latest commit f569b9e271
Martin Drapeau authored March 15, 2012
Octocat-spinner-32 README Deprecated callback. Created more specific onshow callback. Passing D… March 15, 2012
Octocat-spinner-32 feedback.css Update feedback.css February 02, 2012
Octocat-spinner-32 feedback.js Deprecated callback. Created more specific onshow callback. Passing D… March 15, 2012
README
Widget you can embed on your site to capture user feedback.
Saves the User Feedback in Planbox.
Planbox docs: http://www.planbox.com/help/user_feedback


FEATURES
- Supports any localization simply by settings options in global variable FeedbackOptions.
- Style it any way you want by modifying the CSS file feedback.css.
- Uses JSONP to call the Planbox REST API 


REQUIREMENTS
- You need jQuery 1.5+


INSTALLATION
1) Copy feedback.js and feedback.css on your site.

2) Include them in your HTML document like this:
  <link href="/js/feedback/feedback.css" rel="stylesheet" type="text/css" charset="utf-8" />
  <script src="/js/feedback/feedback.js" type="text/javascript"></script>

3) Configure options:
  <script type="text/javascript">
    FeedbackOptions.planboxToken = '123hshdajh2galvnmxnwhruyfhdj';
    FeedbackOptions.dialogTitle = 'Tell us what you think';
  </script>

4) Modify feedback.css to suit your design style.

Note: Files are also hosted on www.planbox.com. You can load them like this as well:
  <link href="http://www.planbox.com/feedback/feedback.css" rel="stylesheet" type="text/css" charset="utf-8" />
  <script src="http://www.planbox.com/feedback/feedback.js" type="text/javascript"></script>


OPTIONS
  // You can find your Planbox initiative token on the Manage page
  // Instructions: http://www.planbox.com/help/user_feedback
  planboxToken: '<TOKEN>',
  
  // You can forward any incoming feedback to an email
  // Keep empty not to. Only a single email is allowed.
  forwardEmail: '',
  	
  // You can set the page URL. If empty will use window.location.href
  pageUrl: '',
  
  // You can specify a human readable page title
  pageTitle: '',
  
  // The button appears center-left by default. Modify in CSS.
  // It is an image you can modify here.
  // If you want your own custom button, set showButton to false.
  // You can then call function FeedbackShow().
  showButton: true,
  buttonImageSrc: protocol+'://www.planbox.com/img/feedback_button.png',
  buttonImageAlt: 'Feedback',
  buttonTooltip: 'Send us Feedback',
  
  // When you click on the button it opens a dialog
  dialogTitle: 'User Feedback',
  dialogCloseTooltip: 'Close dialog',
  dialogEmailLabel: 'Your email',
  dialogFeedbackLabel: 'Your feedback',
  dialogCancelText: 'Cancel',
  dialogSubmitText: 'Submit',
  dialogCloseText: 'Close',
  
  // You can prefill the email
  dialogEmail: '',

  // When the user clicks on Submit, do some validation
  // and tell the user what's happening
  emailIsRequired: true,
  emailInvalidError: 'Please provide a valid email',
  feedbackMissingError: 'Please type in feedback',
  feedbackAjaxSuccess: 'We have received your feedback. Thank you!',
  feedbackAjaxError: 'There was an error.',

  // When the user opens the window
  // The dialog element is passed as argument
  onshow: function(){},

  // Deprecated...

  // When the user opens the window
  // The jQuery content element is passed as argument
  callback: function(){}

FUNCTIONS:
  // If you have your own custom button, call this function to
  // open the Feedback dialog.
  FeedbackShow()
	
Author: Martin Drapeau
Copyright: Planbox Inc. 2011
License: MIT License (http://en.wikipedia.org/wiki/MIT_License)
Something went wrong with that request. Please try again.