angular-debug-bar

Missing AngularJS Debug Bar, which helps you measure performance of your app.

Inspired by: https://github.com/lafikl/perfBar

Usage:

Simply add:

<!-- CSS -->
<link rel="stylesheet" href="dist/css/angular-debug-bar.min.css" />

<!-- JS -->
<script type="text/javascript" src="dist/js/angular-debug-bar.min.js"></script>

to your HTML and then load module ['angular-debug-bar'] and put a directive invocation:

<angular-debug-bar></angular-debug-bar>

at the end of your html template, before </body> tag.

Clear default plugins

You can disable all default loaded plugins.

.config(['debugBarProvider', function (debugBarProvider) {
  debugBarProvider.clearDefaultPlugins();
}]);

Change refresh interval

You can set your own interval time. Default is 1000 ms.

.config(['debugBarProvider', function (debugBarProvider) {
  debugBarProvider.setRefreshInterval(10000);
}]);

Register custom plugin

From version 0.4.0 you can register your own plugin.

.config(['debugBarProvider', function (debugBarProvider) {
  debugBarProvider.registerPlugin('numberOfRequests', function () {
    if ('getEntriesByType' in window.performance) {
      return window.performance.getEntriesByType('resource').length
    }
    return 'N/A';
  }, {
    label: 'Number of requests'
  });
}]);

registerPlugin function takes three arguments: * name [String][required] - name of your plugin to register and store value in the scope * valueFn [Function][required] - function which has to return your plugin value during checking * settings [Object][optional] - optional settings like: * label [String] - label to show below value * unit [String] - unit to show next to value * icon [String] - icon class to prepend value

Modify and build

You can change default styles for the progress bar by editing angular-debug-bar.scss, or override it in your own styles.

To build just type: npm install & bower install & gulp

It will create CSS from SCSS file, and minify JS & CSS files.

Contribution

Feel free to commit your code here :)

TODO

add more default plugins
add some tests [?]

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.