Ember-CLI Addon for displaying a bug-reporting widget to users
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
addon
app/components
config
tests
vendor
.codeclimate.yml
.editorconfig
.ember-cli
.eslintrc.js
.gitignore
.npmignore
.travis.yml
.watchmanconfig
CONTIBUTING.md
LICENSE.md
README.md
ember-cli-build.js
index.js
package.json
testem.js
yarn.lock

README.md

Ember Bug Widget

Build Status npm version Code Climate Codacy Badge Ember Observer Dependency Status

NPM

This addon is a lightweight drop-in bug-reporting widget for your Ember application. Simply add the bug-widget to your application.hbs template and tell it where your bugs should be reported:

Installation

ember install ember-bug-widget

Usage

{{bug-widget url='https://github.com/elwayman02/ember-bug-widget/issues/new'}}

The text of the button defaults to "Report A Bug", but can easily be configured:

{{bug-widget
    url='https://github.com/elwayman02/ember-bug-widget/issues/new'
    text='File An Issue'}}

The widget displays in the bottom right edge of the page by default, and it can currently be moved to the other three corners of the page as well:

Bottom Left -

{{bug-widget
    url='https://github.com/elwayman02/ember-bug-widget/issues/new'
    horizontal='left'}}

Top Left -

{{bug-widget
    url='https://github.com/elwayman02/ember-bug-widget/issues/new'
    horizontal='left'
    vertical='top'}}

Top Right -

{{bug-widget
    url='https://github.com/elwayman02/ember-bug-widget/issues/new'
    vertical='top'}}

Additionally, if you want the widget to be expanded by default, simply initialize the hide attribute as false:

{{bug-widget
    url='https://github.com/elwayman02/ember-bug-widget/issues/new'
    hide=false}}

To further customize the widget, you may use it in the block format and yield your own contents for the button:

{{#bug-widget}}
    I am a custom widget: <a href="http://jhawk.co" target="_blank">Click me!</a>
{{/bug-widget}}

Contributing

CONTRIBUTING.md details how to contribute to this project.

Installation

  • git clone <repository-url>
  • cd ember-bug-widget
  • yarn install

Linting

  • yarn lint:js
  • yarn lint:js --fix

Running tests

  • ember test – Runs the test suite on the current Ember version
  • ember test --server – Runs the test suite in "watch mode"
  • yarn test – Runs ember try:each to test your addon against multiple Ember versions

Running the dummy application

For more information on using ember-cli, visit https://ember-cli.com/.

License

This project is licensed under the MIT License.