Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

This page has not yet been updated to reflect the latest API changes.

...

Returns: The Progress component object.

Note: the initial state of a progress element is assumed to be hidden with the minimum amount of progress.

...

minWidth

Integer which specifies the minimum width for the progress indicator element

pixels

Code Block
javascript
javascript
minWidth: 5

delay

delay before hiding the progress after the Progress.hide() method.

a delay allows the user to register the completion of progress before hiding the progress bar.

millies (milliseconds)

Code Block
javascript
javascript
delay: 0

speed

Integer representing the speed for the Progress animations.

The default is very fast because you want the animation to keep up with the actual speed of the action.

 

Code Block
javascript
javascript
speed: 200

animate

String indicating which directions of progress get animated.

In most cases you only want to animate forward. 

"forward", "backward", and "both". Any other value is interpreted to mean don't animate at all

Code Block
javascript
javascript
animate: "forward"

initallyHiddeninitiallyHidden

Boolean indicating whether to hide the displayElement when initializing Progress.

boolean

Code Block
javascript
javascript
initiallyHidden: true
updatePosition  
Code Block
javascript
javascript
updatePosition: false

...

Selectors

Selectors are used to indicate which elements in DOM should behave as the different Progress elements.
The value for the option is itself a Javascript object containing name/value pairs:

...