###Introduction
jQuery plugin to display a number by counting up, or down, to it over a provided duration. This may be useful for a little added pizaz to widget or a dashboard when a page first loads.
###Usage
Include a link to the updown.js file inside the HTML file you wish to display the UpDown instance in:
<script src="js/updown.js"></script>
Make sure you also include a link to the latest version of jQuery. Being a jQuery plugin, the library is necessary. To initiate the plugin just use the following syntax:
$(selector).updown({});
###Parameters
Parameters are sent in an object literal on initialization of the plug-in.
- Duration: The number of seconds you want the count to last. Default: 5 secods
- Start: The number you want the count to start with. Default: 450
- End: The number you want the count to end with. Default: 100
$(selector).updown({'duration': 10, 'start': 0, 'end':50 });
###Future Plans
- Add a destroy function to kill the instance of the counter
- Add stop and start functions
- Add support for currency and time
- Add support for random numbers before final number is revealed
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.