Home

Awesome

ngProgress.js

Gitter

Build Status

CDNJS

ngProgress is a provider for angular for showing a loading status of something. Use cases can be fetching external resources, showing a action taking more-than-normal length or simple loading between the page views. Prefereble, only for resource heavy sites.

Usage

Download ngProgress.js manually or install with bower

$ bower install ngprogress

Include ngProgress.js ( or ngprogress.min.js) and ngProgress.css in your website.

<script src="app/components/ngprogress/ngprogress.min.js"></script>
<link rel="stylesheet" href="ngProgress.css">

Set ngProgress as a dependency in your module

var app = angular.module('progressApp', ['ngProgress']);

Inject ngProgressFactory in your controller

var MainCtrl = function($scope, $timeout, ngProgressFactory) {}

Create a instance of the progressbar

$scope.progressbar = ngProgressFactory.createInstance();

Use with the API down below

$scope.progressbar.start();
$timeout(function() {
  $scope.progressbar.complete()
}, 1000);

API

ngProgress.start();
ngProgress.setHeight('10px');
ngProgress.setColor('#fff');
var status = ngProgress.status();
ngProgress.stop();
ngProgress.set(100);
ngProgress.reset();
ngProgress.complete();
ngProgress.setParent(document.getElementById('container'));
var element = ngProgress.getDomElement();

Releasing a new version

The current (and quite hacky solution, honestly) to make a new release:

Publishing new Github-pages version

Merge master into gh-pages, run grunt and push to Github

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.