This page presents a proposal for a new API for User Interface Options. It lays out what we would like to expect of an integrator.
Use Case: Out-of-the-box, default settings, no customization (2nd parties)
Guiding Principles
Setting UIO up out-of-the-box – using default panels, with no customizations – should be simple:
- It should 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).
Proposed API
Until schema support is implemented, integrators need a way to say "just give me the settings I saw in the demo."
To create UIO and a page enhancer:
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):
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
fluid.uiOptions(container, {
gradeNames: ["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:
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):
fluid.pageEnhancerWithDefaultSetting({
pathToTocTemplate: "my/sites/", // filename would be in a separate option
siteThemeClassName: "foofer-doodle-theme"
});
which would be equivalent to
fluid.pageEnhancer({
gradeNames: ["fluid.uiOptions.defaultSettings"],
pathToTocTemplate: "my/sites/", // filename would be in a separate option
siteThemeClassName: "foofer-doodle-theme"
});
Once schemas are being used
To create UIO and a page enhancer using out-of-the-box schema for default panels:
fluid.uiOptions(container, {
pathToSchema: "my/sites/lib/infusion/defaultSchema.json",
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 using out-of-the-box schema for default settings:
fluid.pageEnhancer({
pathToSchema: "my/sites/lib/infusion/defaultSchema.json",
pathToTocTemplate: "my/sites/", // filename should be in a separate option
siteThemeClassName: "foofer-doodle-theme"
});
Use Case: Add/remove settings, configure a fresh UIO (3rd parties)
Guiding Principles
Adding panels requires creating components, etc. and therefore requires knowledge of the Framework. For this use case, we expect that integrators understand components, options structures, demands, etc.
- Adding panels should be done through grades, either at invocation time or by adding a grade through a demands block.
- Templates for new panels should be able to be located anywhere i.e. not required to be added to wherever the default templates are.
Consider the use case of the WordPress FSS Theme (which adds UIO to a site) and the VideoPlayer WordPress plugin (which wants to add the media panel to UIO). We want independent modules, plugins, portlets, etc. to be able to add panels to UIO without UIO knowing about it, without other modules, plugins, portlets, etc. knowing about it, without multiple plugins conflicting.
Proposed API
// A grade defining the extra panels and their default settings
fluid.defaults("my.extra.panels", {
defaultSiteSettings: {
foofer: 7,
doodle: true
},
components: {
foofer: {
funcName: "my.integration.fooferPanel",
options: {
template: "myFooferPanel.html" // why can't panels load their own templates?
// if necessary
}
},
doodle: {
funcName: "my.integration.doodlePanel",
options: {
template: "myDoodlePanel.html"
// if necessary
}
}
}
});
// Add the grade to UIOptions
fluid.demands("fluid.uiOptions", "my.integration", {
gradeNames: ["my.extra.settings"]
});
// A grade defining the extra enactors and their default settings
fluid.defaults("my.extra.settings", {
defaultSiteSettings: {
foofer: 7,
doodle: true
},
components: {
foofer: {
funcName: "my.integration.fooferEnactor",
options: {
// if necessary
}
},
doodle: {
funcName: "my.integration.doodleEnactor",
options: {
// if necessary
}
}
}
});
// Add the grade to UIEnhancer
fluid.demands("fluid.uiEnhancer", "my.integration", {
gradeNames: ["my.extra.settings"]
});
Once schemas are being used
To create UIO and a page enhancer using out-of-the-box schema for default panels:
fluid.uiOptions(container, {
pathToSchema: "my/sites/lib/infusion/defaultSchema.json",
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 using out-of-the-box schema for default settings:
fluid.pageEnhancer({
pathToSchema: "my/sites/lib/infusion/defaultSchema.json",
pathToTocTemplate: "my/sites/", // filename should be in a separate option
siteThemeClassName: "foofer-doodle-theme"
});
Use Case: Users of customized UIO (4th parties)
Guiding Principles
Proposed API
Use Case: Localization
Guiding Principles
Integrators should be able to translate a single strings bundle that would take care of the entire interface.
- The strings will all be in a single
.jsfiles that places the message bundle in the global namespace. - To translate, the integrator either
- creates a copy of the file and edits the link in the header to reference translated file (preferred), or
- edits the original file.
Proposed API
There would be no change in the API to translate the interface.