Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Div
stylemax-width: 25%;
classfloatRight
Panel
titleOn This Page
Table of Contents
Panel
titleSee Also

...

Code Block
var prefsEditor = fluid.prefs.create(<container>container[, <config>options]);

Parameters

container(required) (String) A CSS-style selector that will contain the preferences editor markup.

configoptions

(optional) (Object) The configuration Configuration options for the builder. See Options below for more information.
Code Block
var prefsEditor = fluid.prefs.create({
    build: <options>
});

Return Value

Object

(Object) The preferences editor instance.

Return Value

Object

(Object) The preferences editor instance.

Options

NameDescriptionValuesDefault
build(Optional) Configuration options for the builder; see Builder Options below for more information.Object

{}

prefsEditor

(Optional) Configuration options for the preferences editor itself. See PrefsEditor Options below for more information.Object{}

Builder Options

Include Page
_prefs framework builder options
_prefs framework builder options

PrefsEditor Options

NameDescriptionValuesDefault

prefsEditorType

(Optional) The string name of a grade of preference editor.

The Preferences Framework provides three built-in types of editor:

"fluid.prefs.separatedPanelPrefsEditor"
"fluid.prefs.fullNoPreview"
"fluid.prefs.fullPreview"

Integrators can use one of these grades, or define their own grade, using one of these grades as a base grade.

"fluid.prefs.separatedPanelPrefsEditor"

Usage

The simplest way to create a separated panel preferences editor is to provide the primary and auxiliary schema using the options:

...