ember-bug-widget
v3.0.0
Published
Bug reporting widget for Ember applications
Downloads
20
Readme
Ember Bug Widget
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 versionember test --server
– Runs the test suite in "watch mode"yarn test
– Runsember try:each
to test your addon against multiple Ember versions
Running the dummy application
ember serve
- Visit the dummy application at http://localhost:4200.
For more information on using ember-cli, visit https://ember-cli.com/.
License
This project is licensed under the MIT License.