tree: 5177a696447291688cdad9294892f211c8935453 [path history] [tgz]
  1. .bowerrc
  2. .editorconfig
  3. .gitignore
  4. .jshintrc
  5. .npmignore
  6. .travis.yml
  7. CHANGELOG.md
  8. Gruntfile.js
  9. LICENSE
  10. README.google
  11. README.md
  12. angular-spinner.js
  13. angular-spinner.min.js
  14. bower.json
  15. karma.conf.js
  16. package.json
  17. tests.js
third_party/angular-spinner/README.md

angular-spinner

Angular directive to show an animated spinner (using spin.js)

Copyright (C) 2013, Uri Shaked uri@urish.org.

Build Status Coverage Status

Usage

Include both spin.js and angular-spinner.js in your application.

<script src="components/spin.js/dist/spin.js"></script>
<script src="components/angular-spinner/angular-spinner.js"></script>

Add the module angularSpinner as a dependency to your app module:

var myapp = angular.module('myapp', ['angularSpinner']);

You can now start using the us-spinner directive to display an animated spinner. For example :

<span us-spinner></span>

You can also pass spinner options, for example:

<span us-spinner="{radius:30, width:8, length: 16}"></span>

Possible configuration options are described in the spin.js homepage.

Using the usSpinnerService to control spinners

<button ng-click="spin-me">Start spinner</button>
<button ng-click="spin-me">Stop spinner</button>

<span us-spinner spinner-key="spinner-1"></span>

The usSpinnerService service let you control spin start and stop :

app.controller('MyController', ['$scope', 'usSpinnerService', function($scope, usSpinnerService){
    $scope.startSpin = function(){
        usSpinnerService.spin('spinner-1');
    }
    $scope.stopSpin = function(){
        usSpinnerService.stop('spinner-1');
    }
}]);

Note that when you specify a key, the spinner is rendered inactive. You can still render the spinner as active with the spinner-start-active parameter :

<span us-spinner spinner-key="spinner-1" spinner-start-active="1"></span>

The spinner-key will be used as an identifier (not unique) allowing you to have several spinners controlled by the same key :

<span us-spinner spinner-key="spinner-1"></span>
<span us-spinner spinner-key="spinner-2"></span>

... random html code ...

<!-- This spinner will be triggered along with the first "spinner-1" -->
<span us-spinner spinner-key="spinner-1"></span>

License

Released under the terms of MIT License.