angular-simple-sprite

An easy-to-use AngularJS directive for creating simple sprite animations.

Quick Start

• Install angular-simple-sprite with Bower

$ bower install angular-simple-sprite --save

• Include the required libraries in your index.html:

<script src="bower_components/angular/angular.js"></script>
<script src="bower_components/angular-simple-sprite/angular-simple-sprite.min.js"></script>

• Inject the simple-sprite module into your app:

angular.module('myApp', ['simple-sprite']);

• Implement the simple-sprite directive in your HTML:

 <simple-sprite 
    src="path/to/your/image.png" 
    frame-width="100" 
    frame-height="100" 
    frames="10" 
    frames-per-row="5" 
    repeat="true" 
    speed="50">
</simple-sprite>

Be sure to check the demo folder if you'd like to see simple-sprite in action.

Options

• src - The path to your sprite image.
• frame-width - The width of a single frame in your sprite.
• frame-height - The height of a single frame in your sprite.
• frames - The total number of frames in your sprite.
• frames-per-row - Optional The number of frames on each row in your sprite, for example if your frames are arranged 4x2, your frames-per-row is 4. A fully vertical sprite would have a frames-per-row of 1, and a fully horizonal sprite would have a frames-per-row of 0. Defaults to 0.
• repeat - Optional Determines whether or not the sprite animation should repeat. Defaults to true.
• speed - Optional The speed between each frame in milliseconds. Defaults to 100ms.

Author

Tushar Ghate

• http://www.tusharghate.com
• http://github.com/tusharghate

License

The MIT License (MIT)

Copyright (c) 2015 Tushar Ghate

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.