README.md

jQuery asProgress

A jQuery plugin that animate the progress bar.

Table of contents

• Main files
• Quick start
• Requirements
• Usage
• Examples
• Options
• Methods
• Events
• No conflict
• Browser support
• Contributing
• Development
• Changelog
• Copyright and license

Main files

dist/
├── jquery-asProgress.js
├── jquery-asProgress.es.js
├── jquery-asProgress.min.js
└── css/
    ├── asProgress.css
    └── asProgress.min.css

Quick start

Several quick start options are available:

Download the latest build

• Development - unminified
• Production - minified

Install From Bower

bower install jquery-asProgress --save

Install From Npm

npm install jquery-asProgress --save

Install From Yarn

yarn add jquery-asProgress

Build From Source

If you want build from source:

git clone [email protected]:amazingSurge/jquery-asProgress.git
cd jquery-asProgress
npm install
npm install -g gulp-cli babel-cli
gulp build

Done!

Requirements

jquery-asProgress requires the latest version of jQuery.

Usage

Including files:

<link rel="stylesheet" href="/path/to/asProgress.css">
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery-asProgress.js"></script>

Required HTML structure

<div class="progress" role="progressbar" data-goal="100" aria-valuemin="0" data-step="2" aria-valuemax="100">
  <div class="progress__meter"><span class="progress__label"></span></div>
</div>

Initialization

All you need to do is call the plugin on the element:

jQuery(function($) {
  $('.progress').asProgress({
    namespace: 'progress',
  }); 
});

Examples

There are some example usages that you can look at to get started. They can be found in the examples folder.

Options

jquery-asProgress can accept an options object to alter the way it behaves. You can see the default options by call $.asProgress.setDefaults(). The structure of an options object is as follows:

{
  namespace: 'progress',
  bootstrap: false,
  min: 0,
  max: 100,
  goal: 100,
  speed: 20, // speed of 1/100
  easing: 'ease',
  labelCallback(n) {
    const percentage = this.getPercentage(n);
    return `${percentage}%`;
  },
  
  // callbacks
  onStart: function(){},
  onStop: function(){},
  onUpdate: function(){},
  onFinish: function(){},
  onReset: function(){}
}

Methods

Methods are called on asProgress instances through the asProgress method itself. You can also save the instances to variable for further use.

// call directly
$().asProgress('start');

// or
var api = $().data('asProgress');
api.start();

start()

Start the progress animation.

$().asProgress('start');

stop()

Stop the progress animation.

$().asProgress('stop');

finish()

Finish the progress animation. The progress value will update to the goal value immediately.

$().asProgress('finish');

reset()

Reset the progress to first value.

$().asProgress('reset');

go(value)

Update the progress to the specific value.

$().asProgress("go", 50);
$().asProgress("go", '50%');

enable()

Enable the progress animate functions.

$().asProgress('enable');

disable()

Disable the progress animate functions.

$().asProgress('disable');

destroy()

Destroy the progress instance.

$().asProgress('destroy');

Events

jquery-asProgress provides custom events for the plugin’s unique actions.

$('.the-element').on('asProgress::ready', function (e) {
  // on instance ready
});

Event	Description
init	Fires when the instance is setup for the first time.
ready	Fires when the instance is ready for API use.
start	Fired when the start instance method has been called.
stop	Fired when the stop instance method has been called.
update	Fires when the progress value is changing.
finish	Fires when the animation is finished, Or the finish instance method has been called.
reset	Fired when the reset instance method has been called.
destroy	Fires when an instance is destroyed.

No conflict

If you have to use other plugin with the same namespace, just call the $.asProgress.noConflict method to revert to it.

<script src="other-plugin.js"></script>
<script src="jquery-asProgress.js"></script>
<script>
  $.asProgress.noConflict();
  // Code that uses other plugin's "$().asProgress" can follow here.
</script>

Browser support

Tested on all major browsers.

Latest ✓	Latest ✓	Latest ✓	Latest ✓	9-11 ✓	Latest ✓

As a jQuery plugin, you also need to see the jQuery Browser Support.

Contributing

Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing. Make sure you're using the latest version of jquery-asProgress before submitting an issue. There are several ways to help out:

• Bug reports
• Feature requests
• Pull requests
• Write test cases for open bug issues
• Contribute to the documentation

Development

jquery-asProgress is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:

npm install -g gulp
npm install -g babel-cli
npm install

Then you can generate new distributable files from the sources, using:

gulp build

More gulp tasks can be found here.

Changelog

To see the list of recent changes, see Releases section.

Copyright and license

Copyright (C) 2016 amazingSurge.

Licensed under the LGPL license.

⬆ back to top