User Interface Options API

The User Interface Options (UI Options) component allows users to transform the presentation of the user interface and content resources so that they are personalized to the individual user's needs.

UI Options does three things:

  • places a preferences editor dialog with a set of six panels in a collapsible panel at the top of the page, accessible through a button in the upper right corner of the page;
  • instantiates a cookie-based Settings Store for storing the user's preferences; and
  • acts upon the user's preferences.

UI Options is a convenient way to add a simple separated-panel preferences editor to any page. The interface will automatically support the set of "starter" preferences provided by the Preferences Framework, in their default configuration.

Note: If you require any customization of UI Options, you should consider using the Builder tool of the Preferences Framework directly.

Screen shot of the UI Options Component

Creator

Use the following function to create a UI Options component:

Method fluid.uiOptions.prefsEditor(container, options);
Description Instantiate a separated panel version of the UI Options component, which displays the controls in a sliding panel at the top of the page.
Parameters
container
A CSS-based selectors, single-element jQuery object, or DOM element that identifies the root DOM node where the UI Options interface should be placed.
options
An optional data structure that configures the UI Options component, as described below.
Returns The UI Options component
Examples

var myUIO = fluid.uiOptions.prefsEditor("#myContainer", {
    tocTemplate: "../../components/tableOfContents/html/TableOfContents.html"
});
Notes The UI Options uses the page itself as a live "preview:" As users adjust controls, the page is modified accordingly.

Supported Events

Listeners can be attached to any supported events through a component's listeners option. Values can be a function reference (not a string function name) or an anonymous function definition, as illustrated below:

var myComponent = component.name("#myContainerID", {
    listeners: {
        eventName1: functionName,
        eventName2: function (params) {
            // ...
        }
    }
});

For information on the different types of events, see Infusion Event System.

onReady

Description This event fires when the UI Options component is fully instantiated, rendered and ready to use.
Type default
Parameters
uio
The instantiated UI Options component.

onPrefsEditorReady

Description This event fires when the UI Options interface has been rendered into the iframe.
            <div class="infusion-docs-note">
                <strong>Note:</strong> use <code>onReady</code> if the listener needs UI Options to be both rendered
                and ready to use.
            </div>
        </td>
    </tr>
    <tr>
        <th>Type</th>
        <td>default</td>
    </tr>
    <tr>
        <th>Parameters</th>
        <td>
            <dl>
                <dt>prefsEditorLoader</dt>
                <dd>
                    The instantiated preference editor loader component.
                </dd>
            </dl>
        </td>
    </tr>
</tbody>

Options

The second argument to the creator function is the options argument. This is a JavaScript object containing name/value pairs: The name is the name of the option and the value is the desired setting. Components define their own default values for options, but integrators can override these defaults by providing new values using the options argument. For technical information about how options are merged with defaults, see Options Merging.

var uio = fluid.uiOptions.prefsEditor(".myContainer", {
    option1Name: option1value,
    option2Name: option2value
    // ...
});

The options supported by UI Options are described below.

defaultLocale

Description The defaultLocale option allows you to specify the default locale and language of the UI Options interface. The locale specified must have associated JSON message files configured in the options, with the default location in Infusion being: /src/framework/preferences/messages/. The following locales are currently available in the latest version of Infusion: English (CA), English (US), Farsi, French, Spanish.
Note: Locales including both language and territory must specify the language tag followed by the territory separated by an underscore, in that order. E.g. for English (United States), the format would be en_US, or for French (Canada) it would be fr_CA. It is not case-specific, though it is recommended to express the language in lowercase, the territory in uppercase letters and to remain consistent with the naming of the localized message bundle file.
Default "en" (English (Canada))
Example

fluid.uiOptions.prefsEditor("#myContainer", {
    defaultLocale: "fr_CA"
});
See also Localization in the Preferences Framework

tocTemplate

Description The tocTemplate option allows you to specify a custom relative path to the templates used by generating table of contents. This template can be found in the source tree of the Infusion distribution.
Default "../../components/tableOfContents/html/TableOfContents.html"
Example

fluid.uiOptions.prefsEditor("#myContainer", {
    tocTemplate: "html/myTocTemplate.html"
});
See also Table of Contents API

terms

Description The terms option allows you to specify custom relative paths to the templates and message bundles used by the UI Options interface. These templates can be found in the source tree of the Infusion distribution.
Default

{
    templatePrefix: "../../framework/preferences/html",
    messagePrefix: "../../framework/preferences/messages"
}
Example

fluid.uiOptions.prefsEditor("#myContainer", {
    terms: {
        templatePrefix: "../infusion/framework/preferences/html",
        messagePrefix: "../infusion/framework/preferences/messages"
    }
});

prefsEditor

Description The prefsEditor option allows you to specify a data structure to config the prefsEditor component.
Default null
Example

fluid.uiOptions.prefsEditor("#myContainer", {
    prefsEditor: {
        listeners: {
            onReady: function (internalEditor) {...}
            onReset: function (internalEditor) {...}
        }
    }
});

enhancerType

Description The enhancerType option allows you to specify a custom enhancer grade component.
Default "fluid.pageEnhancer"
Example

fluid.uiOptions.prefsEditor("#myContainer", {
    enhancerType: "myNamespace.myUIEnhancer"
});

storeType

Description The storeType option allows you to specify a custom store grade component.
Default "fluid.prefs.globalSettingsStore"
Example

fluid.uiOptions.prefsEditor("#myContainer", {
    storeType: "myNamespace.mySettingsStore"
});
See also Cookie Settings Store

lazyLoad

Description The `lazyLoad` option allows you to specify if the prefsEditor should be lazily loaded. When `lazyLoad` is enabled, the contents of panel, including templates and message bundles are not loaded until the panel is opened. This feature is useful for improving initial page load times, but will cause a brief delay the first time the panel is opened.
Default false
Example

fluid.uiOptions.prefsEditor("#myContainer", {
    lazyLoad: true
});