angular-bootstrap-feedback
Overview
A user feedback modal with screenshot and highlighting functionality built around Angular 1.5+.
Features
- Angular component(s)
- Modal popup
- User can create Screenshots
- User can highlight screenshots
- Include custom inputs
Requirements
- angular - 1.5.0+
- bootstrap - 3.3.6+
- angular-bootstrap - 1.3.2+
- html2canvas - 0.4.1+
Installation
Bower
bower install angular-bootstrap-feedback --save
npm
npm install angular-bootstrap-feedback --save
Manual
Or, you can download source files straight from this repo, they're located in the dist
folder.
Just include the minified version of both .js
and .css
files.
- src/css/angular.bootstrap.feedback.styles.css
- src/lib/angular.bootstrap.feedback.output.js
- src/lib/angular.bootstrap.feedback.templates.js
Or, Minified
- dist/angular.bootstrap.feedback.min.css
- dist/angular.bootstrap.feedback.min.js
Usage
Make sure you have the required bower_components and included them in your html page as well as the angular-bootstrap-feedback files:
1. Injection
Inject the angular.bootstrap.feedback provider into your module
var myApp = angular;
2. Options
Create an options object on the controller. All options are optional, see below for a detailed explanation of each property.
myApp;
3. Setup HTML
The angular components are split into 2 elements:
- angular-bootstrap-feedback
- angular-bootstrap-feedback-screenshot
Please note, the screenshot component is not required.
// Your custom inputs here
Options
Text properties
Property | Description | Default |
---|---|---|
modalTitle | Sets the title of the modal | 'Feedback' |
submitButtonText | Sets the submit button value of the modal | 'Submit' |
takeScreenshotButtonText | Sets the button text value that is fixed to the bottom of the users screen | 'Take Screenshot' |
cancelScreenshotOptionsButtonText | The screenshot options cancel button text | 'Cancel' |
takeScreenshotOptionsButtonText | The screenshot options capture button text | 'Take Screenshot' |
Event callbacks
Event | Description |
---|---|
takeScreenshotButtonPressed | Fired when the take screenshot button is pressed from the modal |
submitButtonPressed | Fired when the submit button is pressed from the modal |
sendFeedbackButtonPressed | Fired when the send feedback button is pressed |
cancelScreenshotOptionsButtonPressed | Fired when a user cancels screenshotting/highlighting |
takeScreenshotOptionsButtonPressed | Fired when the take screenshot button is pressed |
screenshotTaken | Fired when a user takes a screenshot |
highlightDrawn | Fired when the user draws a highlight square |
modalDismissed | Fired when the modal is dismissed |
Contributing
Pull requests and issues are welcome.