API Changes from 2.0 to 3.0

Edit on GitHub

This page contains a list of the features, APIs, and etc. that have changed in Infusion 3.0.

Framework Changes

Core Framework Changes

This section describes major APIs that were in common use. For information about less widely-used features removed in 3.0, consult Deprecations in 2.0.

Model Transformations

  • fluid.transforms.round can take in scale and method options for rounding numbers to a decimal value. Additionally, numbers round away from 0 (i.e 0.5 -> 1, -0.5 -> -1).
  • fluid.transforms.valueMapper takes an defaultInput option to provide the model data directly. This also provides a location for adding nested transformations.

Preferences Framework

Model Changes

Reset

By default, reset will only reset the preferences model path. Other model values will remain unchanged. If you'd like to also have these paths changed, add a listener to the beforeReset event to execute a fireChangeRequest for the model paths you need to reset. (See: ArrowScrolling.js)

listeners: {
    "beforeReset.resetPanelIndex": {
        listener: "{that}.applier.fireChangeRequest",
        args: {path: "panelIndex", value: 0, type: "ADD", source: "reset"}
    }
}
Model Paths

Any prefsEditor using the fluid.prefs.arrowScrolling grade, such as the one contained in fluid.prefs.separatedPanel, will contain the following new model paths.

Model Path Default Description
panelIndex 0 The index of the panel to scroll to in the small screen responsive view.
panelMaxIndex A number representing the index of the last panel The maximum index that panelIndex can take. It is calculated from the total number of panels present.

Panel Changes

Selectors

All panels must supply a header selector, which will be used by the fluid.prefs.arrowScrolling grade to provide the clickable arrows for navigating between adjusters in the small screen responsive view.

Line Spacing

The "Line Spacing" panel was refactored to be based off of the fluid.prefs.panel.stepperAjuster grade.

Model Changes
In 3.0.0 In 2.0.0
value lineSpace
Message Bundle Changes
Message Bundle In 3.0.0 In 2.0.0
lineSpace.json "label" "lineSpaceLabel"
"description" "lineSpaceDescr"
"multiplier"

The "Links and Buttons" adjusters and enactors are collapsed to a single preference called "Enhance Inputs".

Model Changes
In 3.0.0 In 2.0.0
value
  • links
  • inputsLarger
Message Bundle Changes
In 3.0.0 In 2.0.0
Message Bundle Property Message Bundle Property
enhanceInputs.json label linksControls.json linksControlsLabel
description inputsLarger.json inputsChoiceLabel
linksControls.json LinksChoiceLabel
switchOn
switchOff
Table of Contents

The table of contents panel was refactored to be based off of the fluid.prefs.panel.switchAdjuster grade.

Model Changes
In 3.0.0 In 2.0.0
value toc
Message Bundle Changes
Message Bundle In 3.0.0 In 2.0.0
tableOfContents.json "label" "tocLabel"
"description" "tocDescr"
"switchOn"
"switchOff"
Text Size

The text size panel was refactored to be based off of the fluid.prefs.panel.stepperAjuster grade.

Model Changes
In 3.0.0 In 2.0.0
value textSize
Message Bundle Changes
Message Bundle In 3.0.0 In 2.0.0
textSize.json "label" "textSizeLabel"
"description" "textSizeDescr"
"multiplier"
Text to Speech

The text to speech panel was refactored to be based off of the fluid.prefs.panel.switchAdjuster grade.

Model Changes
In 3.0.0 In 2.0.0
value speak
Message Bundle Changes
Message Bundle In 3.0.0 In 2.0.0
speak.json "label" "speakLabel"
"description" "speakDescr"
"switchOn"
"switchOff"

Component API Changes

Tabs Component

The fluid.tabs component has been removed.

Reorderer Component

  • The stylisticOffset selector was no longer in use and has been removed.