Gallery

Modules

Documentation

Context Navigation

YUI Library is not responsible for bugs or support with this module. It is available as a free service. For support please contact the module owner with the provided links.

Async Progress Plugin (gallery-async-progress) on cdn

Last Updated: 06/21/12

+ 0 -

Steven Olmsted

YUI Contributor

See 42 more by this user.

Created: 02/12/12
Last CDN Push: 06/20/12
Build Tag: gallery-2012.06.20-20-07
Project: YUI 3
License: YUI BSD
YUI Version: 3.5.1
Free for use.

Adds a progress event to Y.Async to easily track the progress of a run.

If you haven't seen gallery-async, start there: http://yuilibrary.com/gallery/show/Async

Once plugged, Y.Async will fire progress events. The eventFacade will contain the properties completed and total.

Code Sample

<script src="http://yui.yahooapis.com/3.5.1/build/yui/yui-min.js"></script>

YUI({
    //Last Gallery Build of this module
    gallery: 'gallery-2012.06.20-20-07'
}).use('gallery-async-progress', 'node', function(Y) {
        var progressNode = Y.one('#progress'),
 
        // This is a dummy function that represents something happening.
        unitOfWork = function (success) {
            Y.later(Math.random() * 500 + 500, null, success);
        };
 
    Y.Async.runQueue(unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork, unitOfWork).plug(Y.Plugin.AsyncProgress).on('progress', function (eventFacade) {
        progressNode.set('text', Math.floor(eventFacade.completed / eventFacade.total * 100) + '% Complete');
    });
});