API changes in 1.3: Progress

Cheetham, Anastasia acheetham at ocad.ca
Wed Nov 3 19:56:10 UTC 2010

Here is a summary of the Progress API changes that are currently expected to be released with 1.3:

Changes to Default Values of Options

New Options
new strings option: (wasn't there before)
   strings: {
        ariaBusyText: "Progress is %percentComplete percent complete",
        ariaDoneText: "Progress is complete."

new events option: (wasn't there before)
    events: {            
        onProgressBegin: null,
        afterProgressHidden: null            
Note that these options replace the deprecated 'callback' properties of the showAnimation and hideAnimation options

all-new options:
    textEditButtonRenderer: defaultTextEditButtonRenderer, // a function that creates the textEditButton
    renderKeyboardTooltip: true,
    urls: {
        textEditButtonImage: "../images/inline_edit_edit_button_16x16.png"

Deprecated Options
The 'callback' properties of showAnimation and hideAnimation are deprecated, replaced by the new events.

Deleted Options
    ariaBusyText: "Progress is %percentComplete percent complete",
    ariaDoneText: "Progress is complete."
These two strings have been moved into the new 'strings' option. I believe the decision was made NOT to maintain backward compatibility because the Progress component is still in Preview status.

Anastasia Cheetham     Inclusive Design Research Centre
acheetham at ocad.ca            Inclusive Design Institute
                                        OCAD University

More information about the fluid-work mailing list