Versions Compared

Key

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

...

Setting UIO up out-of-the-box – using default panels, with no customizations – should be dead- simple:

  • It should not require minimal knowledge of the Framework.
  • It should not require knowledge of subcomponents in the UIO component tree.
  • Any options that might be set should be top-level.
    • Option names should make sense.
  • Integrators should not have to create both a page enhancer and the fat panel individually; If they want the fat panel, the page enhancer would be assumed and should be instantiated on the page automatically.
  • Integrators may want to create a page enhancer without UIO (in the case of a full-page UIO available elsewhere, through a link).

...

To create UIO and a page enhancer:

Code Block
javascript
javascript

fluid.uiOptions(container, {
    gradeNames: [<gradenames of desired panels>],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

Access to the default panels would be made easy through a "flavour" of uiOptions (similar to flavours of Reorderer):

Code Block
javascript
javascript

fluid.uiOptionsWithDefaultPanels(container, {
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

which would be equivalent to

Code Block
javascript
javascript
fluid.uiOptions(container, {
    usePrepackagedSettingsgradeNames: true["fluid.uiOptions.defaultPanels"],
    pathToTemplates: "my/sites/lib/infusion/templates/",
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

To create only a page enhancer:

Code Block
javascript
javascript

fluid.pageEnhancer({
    gradeNames: [<grade names for desired settings>],
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

Access to the default setting would be made easy through a "flavour" of enhancer (similar to flavours of Reorderer):

Code Block
javascript
javascript
fluid.pageEnhancerWithDefaultSetting({
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

which would be equivalent to

Code Block
javascript
javascript

fluid.pageEnhancer({
    usePrepackagedSettingsgradeNames: true["fluid.uiOptions.defaultSettings"],
    pathToTocTemplate: "my/sites/", // filename would be in a separate option
    siteThemeClassName: "foofer-doodle-theme"
});

...