UProgress

Creates and control a µProgress.

Kind: global class

new UProgress([parent], [opts], [rtl])

• Create a new UProgress instance.
• Create a div for the µProgress and add it to the parent.
• Register to the resize event.

uProgress.start() ⇒ boolean

Display the µProgress and start its progress from opts.start to opts.end at a speed corresponding to opts.duration. Has no effect if the µProgress is already started.

Kind: instance method of UProgress
Returns: boolean - true if the µProgress has started, false otherwise.
Example
Start the µProgress.

const uProgress = new UProgress();
uProgress.start();
// true

uProgress.set(duration, [target], [force]) ⇒ boolean

Change the µProgress target and the speed at which it reaches it. Useful to give a more accurate progress of multiple sequentials tasks. If the value of duration parameter is equal or greater than 1, then the µProgress will automatically fade out once it reaches 100% progress (equivalent to calling done with opts.doneDuration = duration).

Kind: instance method of UProgress
Returns: boolean - true if the µProgress duration or target has been changed, false otherwise.

Example
Update µProgress speed based on tasks progress.

// doHeavyTask calls a callback when done and is expected to takes up to 7s
// doLightTask calls a callback when done and is expected to takes up to 3s
const uProgress = new UProgress({
  duration: 7000
  end: 0.7
});
uProgress.start();
doHeavyTask(() => {
  // when heavy task is done
  uProgress.set(3000, .99);
  doLightTask(() => {
    // When light task is done
    uProgress.done();
  });
});

uProgress.done(destroy) ⇒ boolean

Gracefully complete the µProgress by moving quickly to 100% progress and then fading out. It will moves to 100% at the speed corresponding to opts.doneDuration and then fade out with the duration of opts.fadeDuration. Has no effect if the µProgress is not started or if done).

Kind: instance method of UProgress
Returns: boolean - true if the µProgress is going to be completed, false otherwise.

Example
Complete the µProgress once the monitored task is done.

// `doTask` calls a callback when done
const uProgress = new UProgress();
uProgress.start();
doTask(() => {
  // when task is done,
  uProgress.done();
});

uProgress.status() ⇒ Status | boolean

Get the Status of the µProgress if it’s not destroyed, false otherwise.

Kind: instance method of UProgress
Returns: Status | boolean - The current Status or false.
Example
Get the status.

const uProgress = new UProgress({duration: 20000});
uProgress.start();
setTimeout(() => {
  uProgress.status();
  // {target: 0.99, duration: 15000, progress: 0.25}
}, 5000);

uProgress.options([opts], [rtl]) ⇒ UProgress

Update the µProgress instance configuration.

Kind: instance method of UProgress
Returns: UProgress - this, chainable

Example
Change duration.

const uProgress = new UProgress();
uProgress.options({duration: 20000}).start();
setTimeout(() => {
  uProgress.status();
  // {target: 0.99, duration: 5000, progress: 0.75}
}, 15000);

uProgress.refresh()

Update the µProgress with and position based on its parent width. This methods is automatically called on a window resize event. However it has to be called manually if the parent container width changes for a reason other than a window resize.

Kind: instance method of UProgress
Example
Create a new µProgress on top of a modal and change it’s width.

const uProgress = new UProgress(document.getElementById('my-modal'));
// Modify the modal content (i.e. refresh content with Ajax)
changeModalContent();
uProgress.refresh();

uProgress.destroy()

• Remove the µProgress from the DOM.
• Remove the resize event listener if this is the only non-destroyed instance.

Kind: instance method of UProgress

UProgress.Default : Object

The default options for all new µProgress instances.

Kind: static constant of UProgress
Read only: true
Properties

Example
Change default options

UProgress.Default.duration = 3000;
UProgress.Default.class = 'custom-uprogress';

UProgress~Status : Object

Status of the µProgress instance.

Kind: inner typedef of UProgress
Properties