Documentation for a historical release of Infusion: 1.4
Please view the Infusion Documentation site for the latest documentation, or the Infusion 1.3. Documentation for the previous release.
If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

fluid.defaults

Owned by Anastasia Cheetham
Last updated: Apr 08, 2011 by Harris WongVersion comment

fluid.defaults(global, componentName, defaults)

Centrally stores and retrieves a component's default settings.

fluid.defaults(global, componentName, defaults);

File name: Fluid.js

Parameters

global (boolean) Optional: If true, manipulate a global option (for the head component) rather than instance options. Note that this is deprecated as of v1.3
componentName (String) the name of the component
defaults (Object) a container of key/value pairs to set. See #Defaults Structure below for information about the format of this object.

Return Value

Object If the object is passed in the argument, this is added to the store and then returned. If not, the current object in the store is returned.

See Also

Notes

Defaults Structure

The defaults object ...

{
    option1: <default value for option one>,
    option2: {
        subOpt1: <default for sub-option1>,
        subOpt2: <default for sub-option1>
    }
}
The array of arguments can contain references to...

Example

fluid.defaults("inlineEdit", {
    selectors: {
        text: ".text",
        editContainer: ".editContainer",
        edit: ".edit"
},

In this example, the default selectors(text, editContainer, edit) for inlineEdit are set to the element with the following classes respectively, text, editContainer, edit. As the componenent's creator starts up, it will merge together the user's instance options to produce its runtime options.