jquery-circle-progress


`

Events
------

| Event | Description | Handler |
| ---- | ---- | ---- |
| circle-inited | Triggered on init or re-init. | function(event):
- event - jQuery event |
| circle-animation-start | Triggered once the animation is started. | function(event):
- event - jQuery event |
| circle-animation-progress | Triggered on each animation tick. | function(event, animationProgress, stepValue):
- event - jQuery event
- animationProgress - from 0.0 to 1.0
- stepValue - current step value: from 0.0 to value |
| circle-animation-end | Triggered once the animation is finished. | function(event):
- event - jQuery event |

Browsers support
----------------

The library uses which is supported by all modern browsers (including mobile browsers)
and Internet Explorer 9+ (Can I Use).

I haven't implemented any fallback / polyfill for unsupported browsers yet
(i.e. for Internet Explorer 8 and older / misc browsers).

UMD
---

I use UMD template for jQuery plugin which combines three things:

* works fine with _browser globals_
* works fine with AMD
* works fine with CommonJS

$3

`html



`

$3

Assuming that you have jquery, jquery-circle-progress and requirejs in libs/ directory:

`html


`

You can configure RequireJS as you wish, just make 'jquery' dependency reachable.

$3

`js
// script.js
require('jquery-circle-progress');
var $ = require('jquery');
$('#circle').circleProgress({
value: 0.75
});
`

`sh
some-js-bundler < script.js > script.bundle.js
`

`html

`

You can use any JS bundler (Webpack, Browserify, etc) - no specific configuration required.

API
---

$3

Get it:

`js
$('.circle').circleProgress({ value: 0.5 });
var value = $('.circle').circleProgress('value'); // 0.5
`

It will return the first item's value (by first I mean when $('.circle').length >= 1).
It works only if the widget is already inited. Raises an error otherwise.

Set it:

`js
$('.circle').circleProgress('value', 0.75); // set value to 0.75 & animate the change
`

It will update all selected items value and animate the change.
It doesn't redraw the widget - it updates the value & animates the changes.
For example, it may be an AJAX loading indicator, which shows the loading progress.

$3

`js
$('.circle').circleProgress({ value: 0.5 });
var canvas = $('.circle').circleProgress('widget');
`

It will return the first item's (by first I mean when $('.circle').length >= 1).
It works only if the widget is already inited. Raises an error otherwise.

$3

`js
var instance = $('#circle').data('circle-progress');
`

$3

`js
$('#circle').circleProgress({ value: 0.5, fill: { color: 'orange' }});
$('#circle').circleProgress('redraw'); // use current configuration and redraw
$('#circle').circleProgress(); // alias for 'redraw'
$('#circle').circleProgress({ size: 150 }); // set new size and redraw
`

It works only if the widget is already inited. Raises an error otherwise.

$3

`js
$.circleProgress.defaults.size = 50;
`

FAQ
---

How to start the animation only when the circle appears in browser's view (on scrolling)?

Here is my proposed solution.

How to make the size flexible?

E.g. for responsive design, you can do it in the following way.

What if I need it to run in IE8?

There is no full-feature support for IE8 (actually, I didn't imlpement IE8 support at all). But you may follow my recommendations.

How to stop the animation?

Here is what you can do.

Can I handle "click" event?

It's not in the "core" but you can use my example of mouse/touch events handling.

May I customize the shape somehow?

It's a bit "tricky" but possible. Here is my little collection.

Development
-----------

$3

`sh
git clone git@github.com:kottenator/jquery-circle-progress.git
npm install
`

$3

You need to update dist/circle-progress.min.js after any change to dist/circle-progress.js:

`sh
npm run build-min
`

If you're using one of JetBrains IDEs - you can configure a File Watcher.
It's also possible to use some CLI tool like Watchman.

$3

`sh
npm test
`

SauceLabs:

`sh
export SAUCE_USERNAME=...
export SAUCE_ACCESS_KEY=...
export BUILD_NUMBER=...
npm test -- karma-saucelabs.conf.js
`

$3

The API docs are not complete yet but you can build them:

`sh
npm run build-docs
`

They will be generated in docs/api/.

$3

* finalize the code
* update the version in package.json, bower.json and dist/circle-progress.js docstring
* update min dist: npm run build-min
* update docs/index.html - link to the latest dist version _(which doesn't exist yet)_
* push the changes to master branch
* release on Bower: just create a Git tag (e.g.): git tag v1.2.3 && git push --tags
* release on GitHub - add release notes to the Git tag
* release on NPM: npm publish`, but be aware:

> Once a package is published with a given name and version, that specific name and version combination can never be used again - NPM docs