## ngProgress.js

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/VictorBjelkholm/ngProgress?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/VictorBjelkholm/ngProgress.png?branch=master)](https://travis-ci.org/VictorBjelkholm/ngProgress)

**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

```bash
$ bower install ngprogress
```

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

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

Set **ngProgress** as a dependency in your module

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


Inject **ngProgressFactory** in your controller

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

Create a instance of the progressbar

```javascript
$scope.progressbar = ngProgressFactory.createInstance();
```

Use with the API down below

```javascript
$scope.progressbar.start();
$timeout($scope.progressbar.complete(), 1000);
```

## API

* **start** - Starts the animation and adds between 0 - 5 percent to loading
each 400 milliseconds. Should always be finished with ngProgress.complete()
to hide it

```javascript
ngProgress.start();
```
* **height** - Sets the height of the progressbar. Use any valid CSS value
Eg '10px', '1em' or '1%'

```javascript
ngProgress.height('10px');
```

* **color** - Sets the color of the progressbar and it's shadow. Use any valid HTML color

```javascript
ngProgress.color('#fff');
```

* **status** - Returns on how many percent the progressbar is at. Should'nt be needed

```javascript
var status = ngProgress.status();
```

* **stop** - Stops the progressbar at it's current location

```javascript
ngProgress.stop();
```

* **set** - Set's the progressbar percentage. Use a number between 0 - 100. If 100 is provided, complete will be called.

```javascript
ngProgress.set(100);
```

* **reset** - Resets the progressbar to percetage 0 and therefore will be hided after it's rollbacked

```javascript
ngProgress.reset();
```

* **complete** - Jumps to 100% progress and fades away progressbar

```javascript
ngProgress.complete();
```

* **setParent** - Changes the parent of the DOM element which visualizes the progress bar

```javascript
ngProgress.setParent(document.getElementById('container'));
```

* **getDomElement** - Gets the DOM element  which visizualizes the progress bar. It is wrapped as a jqlite element - https://docs.angularjs.org/api/ng/function/angular.element

```javascript
var element = ngProgress.getDomElement();
```

## Releasing a new version

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

* Update package.json to have new version.

* Commit changes

* Run ```bower version patch|minor|major```

## 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.
