Comments:"ngProgress - slim, site-wide progressbar for AngularJS"
URL:http://victorbjelkholm.github.io/ngProgress/
ngProgress
Slim, site-wide progressbar for Angular
I recently saw Youtube's and Medium's new loading bars (and Medium don't get it) and was interested in implementing it on my own. In comes NProgress ( https://github.com/rstacruz/nprogress ), a jQuery dependent plugin for the effect.
The jQuery dependency didn't exactly helped me so I've created my own AngularJS Provider that I can use for my heavy-applications. Try it out, fork it and submit a pull request if you want!
Right now, the plugin weighs 5kb, containes 8 different methods and have a dependency on Angular (duh).
Reach out to me on Twitter ( @VictorBjelkholm ) if you have feedback, critics or just want someone to blame for your problems. Or, visit the Github repository
Installation
Download ngProgress.js manually or install with bower
bower install ngprogress
Include ngProgress.js in your application
<script src="app/components/ngProgress/ngProgress.js"></script>
Set ngProgress as dependency in your module
var app = angular.module('progressApp', ['ngProgress']);Inject progressbar-provider in the controller where you need it
var MainCtrl = function($scope, progressbar) {
}Use be following the API below or checking out the source to this page.
progressbar.start();
Share
Since the providers quality depends on peer-review, please review it yourself or share it to people that like to review stuff. I would be forever grateful and buy you an coffee if you are in Barcelona
API
progressbar.start();
Starts the animation and adds between 0 - 5 percent to loading each 400 milliseconds. Should always be finished with progressbar.complete() to hide it
progressbar.height();
Sets the height of the progressbar. Use any valid CSS value Eg '10px', '1em' or '1%'
progressbar.color();
Sets the color of the progressbar and it's shadow. Use any valid HTML color
progressbar.status();
Returns on how many percent the progressbar is at. Should'nt be needed
progressbar.stop();
Stops the progressbar at it's current location
progressbar.set();
Set's the progressbar percentage. Use a number between 0 - 100. If 100 is provided, complete will be called.
progressbar.reset();
Resets the progressbar to percetage 0 and therefore will be hided after it's rollbacked
progressbar.complete();
Jumps to 100% progress and fades away progressbar.
License
The MIT License (MIT)
Copyright (c) 2013 Victor Bjelkholm
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.