This documentation is currently being moved to our new documentation site.

Please view or edit the documentation there, instead.

If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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.

  • No labels